jsDoc jsDoc學習記錄

2021-10-04 04:37:10 字數 2004 閱讀 9597

npm

install -g jsdoc # 全域性安裝

1. 常用
/**

*@file 這是檔案描述

*@summary 描述的簡要概括

*@author 作者

*@version 版本

*@license 許可證

*//**

* 在開頭可以省略@description,直接寫描述

* @description 後面追加的描述會覆蓋前文

*/

/** 

* @example usage example

* var h = sayhello();

* console.log(h);

*/function

sayhello()

/** constructor */

function

thingy()

/** 

* @param somebody - someone you want to say hello to. // 普通寫法

* @param somebody='john' - someone you want to say hello to. // 帶預設值

* @param [somebody] - someone you want to say hello to. // 可選引數

* @param somebody - someone you want to say hello to. // 多型別

* @param somebody - someone you want to say hello to. // 任意型別

* @param somebody - someone you want to say hello to. // 可重複

*/function

sayhello

(somebody)

/**

* @namespace

* @property defaults - the default values for parties.

* @property defaults.players - the default number of players.

* @property defaults.level - the default level for the party.

* @property defaults.treasure - the default treasure.

* @property defaults.treasure.gold - how much gold the party starts with.

*/var config =}}

;

@typdef自定義型別

/**

*@typedef numberlike

*/

/**

*@returns

*/

/**

*@throws

*/

2. 其他

@listens@member@var成員

@memberof@static靜態成員

@mixes被混入

@mixin混入

@namespace@override

jsdoc yourfile.js

mysql學習記錄 MySQL學習記錄 2

in 子查詢 select from student where id in 1,2 not in 不在其中 select from student where id not in 1,2 is null 是空 select from student where age is null is not...

java學習記錄

陣列雖然是引用資料型別,但它不是類 所以數字中沒有length 方法 只有length屬性。string型別 是乙個類 jdk中已經封裝好的類,是個final類,你可以去查api 類就有屬性和方法但是 string類中沒有length屬性,只有length 方法 1。陣列雖然是引用資料型別,但它不是...

Linux 學習記錄

1.linux 拷貝隱藏檔案 進入當前需要拷貝的目錄,即源目錄 假如 source 拷貝到 centos5.3 cd source tar cf cd centos5.3 tar xvf 或者 cp r centos5.3 2.linux 下新增postgresql 使用者 進入 postgresq...