很高興webstorm可以直接使用,爲了導出api記錄一下
1.安裝
命令行 cnpm install -g jsdoc
2.導出文檔
命令行 jsdoc {需要轉爲API的文件} -d {輸出路徑}
示例 :
>jsdoc zhiu_Foundation/ZhiUTech.js -d ZhiU_Engine/zhiu_API1
基礎使用
/** 寫一下下面的意思
*@function 方法名稱
*@param {參數類型} 參數名稱 參數含義
*@return {返回類型} 返回名稱 返回含義
*/
參數說明 :
1.@function
表示該下方結構爲function
例:
@function funcName
2.@name
可以跟在@function 下方標識方法名稱
例:
@function
@name funcName
也可以標識下方對象名稱
例:
@name objectName
3.@summary
用於標註下方結構的作用
例:
@summary A concise summary.
4.@param
用於描述參數的 類型 名稱 作用
例:
@param {string} variableName variableEffect
function Func(variableName){}
如果參數爲對象並含有屬性
例:
@param {Person} person A person variable
@param {string} person.Name his name
@param {int} person.Age his age
function Func(person){}
如果含有可選參數
例:
@param {string} [variableName] variableEffect
如果含有可選參數並且有默認值
例:
@param {string} [variableName=LJason] variableEffect
如果參數的類型有多重選擇
例:
@param {string | string[]} variableName variableEffect
如果參數的類型不限
例:
@param {*} variableName variableEffect
5.@callback
用於描述回調函數
例:
(全局回調)
/**
* this is a load success callback
* @callback SuccessAction
* @param {number} responseCode
* @param {string} responseMessage
*/
調用:
/** @function LoadModel
* @summary this func can load model
* @param {SuccessAction} callback model loaded callback
*/
function LoadModel(callback){}
(局部回調)
/**
* this is a load success callback
* @callback Object~SuccessAction
* @param {number} responseCode
* @param {string} responseMessage
*/
調用:
/**
* @summary this func can load model
* @param {Object~SuccessAction} callback model loaded callback
*/
Object.load=function(callback){}