* @param {Object} book * @param {string} book.title * @param {string} book.author */ function buyBook(book) { } 这样我们在使用book的使用就会提示出所有的属性和方法! 不过这样我们在每个函数内部都使用到了book的时候,都得在注释里面写三句话,使用起来就比较麻烦! @typedef和property 我们可以使用@...
*/function Book(title, author) {}生成网站 一旦你的代码是已注释的,你可以是用 JSDoc 3的工具从源文件中生成一个 HTML 网站。 默认情况下,JSDoc 使用内置的“默认”模板将文档转换为 HTML。您可以根据自己的需要编辑此模板,或者创建一个全新的模板(如果您喜欢的话)。 在命令行上运行文档生成器: jsdoc...
*@returns{string} */Book.prototype.getTitle=function(){returnthis.title; }/** * 根据书本标题获取书本作者 *@param{String}title*/Book.prototype.getAuthor=function(title){}/** * 根据书本标题获取书本目录 *@param{String}title*/Book.prototype.getBookCatalog=function(title){}/** * 设置书本的页...
*/ function Book(title, author) { } 生成API文档 我是用的基于Grunt的插件:grunt-jsdoc。 具体用法见这里。下面是我的grunt-doc的配置 代码语言:javascript 代码运行次数:0 运行 AI代码解释 'jsdoc': { src: ['my-lib/*/*.js', '!my-lib/doc/**/*.js'], options: { destination: 'my-lib/...
Book.prototype={ getTitle:function(){ returnthis.title; }, setPageNum:function(pageNum){this.pageNum=pageNum; } }; 如果使用了 JSDoc 注释该代码后,代码的可阅读性就大大的提高了。 /** * Book类,代表一个书本. * @constructor * @param {string} title - 书本的标题. ...
JSDoc注释一般应该放置在方法或函数声明之前,它必须以/ **开始,以便由JSDoc解析器识别。其他任何以/*,/***或者超过3个星号的注释,都将被JSDoc解析器忽略。例如一下代码: /** * Book类,代表一个书本. *@constructor*@param{string}title- 书本的标题. ...
*/ function Book(title, author) { this.title=title; this.author=author; } 标签 块标签 通常会提供有关您的代码的详细信息。总是以 at 符号(@)开头每个块标签后面必须跟一个换行符。 内联标签 对块标签文本中的说明,用{}包裹。 /** * 设置颜色 *见 {@link http://www.google.com} * @...
* Represents a book *@constructor*@param{string} title - The title of the book *@param{string} author - The author of the book **/functionBook(title, author){ } 生成网站 将代码添加了规定的注释之后,可以使用jsdoc3工具根据代码生成HTML网站。
functionBook(title, author) { } 生成API文档 我是用的基于Grunt的插件:grunt-jsdoc。 具体用法见这里。下面是我的grunt-doc的配置 1 2 3 4 5 6 'jsdoc': { src: ['my-lib/*/*.js','!my-lib/doc/**/*.js'], options: { destination:'my-lib/doc' ...
返回一个promise /*** @returns {Promise<Book>} 我返回了一个promise*/getInfoPromise(){returnPromise.resolve(this);}