在代码注释中文档化补丁属性。
示例:
/**
* @patch
* This method applies the specified patch to the object.
* @param {Object} patch - The patch to apply.
* @param {string=} options - The options to use when applying the patch.
* @param {boolean=} options.validate - Whether to validate the patch before applying it.
*/
applyPatch(patch, options) {
// implementation
}
在上述示例中,@patch
注释标记文档化了该方法支持补丁操作。@param
注释标记文档化了该方法的参数,其中 patch
参数是必需的,而 options
参数是可选的。@param
命令后方的括号表示参数类型,=
后面的单词表示该参数可选。@param
注释均使用 JSDoc 语法编写,以便生成自动化 API 文档。