同義詞
defaultvalue
語法
@default [<some value>]
概述
@default 標籤允許您記錄符號的指定值。您可以自己提供這個標籤的值,或者您可以允許 JSDoc 從原始碼自動記錄值 -- 僅當記錄的符號被指定一個單一、簡單的值時才有可能,該值可以是:字串、數字、布林值或 null。
範例
在此範例中,一個常數被記錄。常數的值為 0xff0000
。透過新增 @default 標籤,此值會自動新增到文件中。
/**
* @constant
* @default
*/
const RED = 0xff0000;