js doc 前端开发自动生成说明文档001

0. 全局安装使用

1. 安装 

npm install -g jsdoc

ps： 尽量使用淘宝镜像 修改npm的指向地址 

检查安装成功 jsdoc -v  // v是小写

2. 体验

2.1 在任意目录下 创建一个jsdocDemo.js的文件 输入如下内容

以/** 开始 至  */结束 中间内容注释 既为jsdoc自动创建文档的内容

/** 
 * 获取指定的URL参数值 
 * URL:http://www.xdoc.com/index?xdoc=x.document 
 * 参数：paramName URL参数 
 * 调用方法:getParam("xdoc") 
 * 返回值:tyler 
 */ 
function GetRequest() {  
   var url = location.search; //获取url中"?"符后的字串  
   var theRequest = new Object();  
   if (url.indexOf("?") != -1) {  
      var str = url.substr(1);  
      strs = str.split("&");  
      for(var i = 0; i < strs.length; i ++) {  
         theRequest[strs[i].split("=")[0]]=unescape(strs[i].split("=")[1]);  
      }  
   }  
   return theRequest;  
}  

2.2  执行创建命令

jsdoc jsdoc.js
//执行过后 可以看到在jsdoc.js同级目录下出现一个out文件夹 out内就是自动生成的api文档
//运行 index.html文件 就可以看到我们写的 GetRequest 方法的用法和源代码都出现在页面上。