簡體   English   中英

JSDoc - 稍后定義的 object 屬性的文檔

[英]JSDoc - Documentation for object property that is defined later

如何記錄 object 屬性/方法,當此屬性/方法稍后添加到 object,在 object 已初始化后?

例子:

假設我聲明了以下 object。 IDname的文檔工作正常:

let AppUser = {
   /** The user's id */
   ID: 0,
   /** The user's name */
   name: "guest",
};

后來,我決定添加一個屬性(假設在另一個 js 文件中):

/** The role of the AppUser */
App.role = "admin";

在這種情況下, App.role的文檔不起作用。 至少,VSCode 不會打開工具提示來通知我它的描述。

我現在要做的是在 object: role:null,並編寫它的文檔。 此解決方法工作正常。

為了使它工作,object 的定義應該有點不同。 類似於以下內容:

一個.js

const AppUser = {}

AppUser.ID = 0
AppUser.name = 'guest'

b.js

AppUser.role = 'admin'

c.js

截屏

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM