angular-jsdoc, AngularJS的template模板/插件

分享于 

7分钟阅读

GitHub

  繁體 雙語
AngularJS Template/Plugin for JSDoc 3.
  • 源代码名称:angular-jsdoc
  • 源代码网址:http://www.github.com/allenhwkim/angular-jsdoc
  • angular-jsdoc源代码文档
  • angular-jsdoc源代码下载
  • Git URL:
    git://www.github.com/allenhwkim/angular-jsdoc.git
    Git Clone代码到本地:
    git clone http://www.github.com/allenhwkim/angular-jsdoc
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/allenhwkim/angular-jsdoc
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    角 jsdoc

    AngularJS的JSDoc 3模板。
    一个用于AngularJS的JSDoc插件和模板,什么也没有 !

    注意:配置文件和模板目录的位置已经移动到 1.0.0的版本中,请进行相应的修改。

    • 配置:旧: node_modules/angular-jsdoc/conf.json 新建: node_modules/angular-jsdoc/common/conf.json
    • 模板:旧: node_modules/angular-jsdoc/template 新建:node_modules/angular-jsdoc/default

    博客:的叹息,AngularJS的文档文档。

    特性

    • 右侧 TOC,内容 table,用于指令。服务。控制器等导航
    • 读取和处理 @ngdoc 标记

    它看起来像?

    安装

    
    $ npm install jsdoc angular-jsdoc --save-dev
    
    
    
    

    如果要将它的与Grunt一起使用,请执行以下操作:

    
    $ npm install grunt-jsdoc --save-dev
    
    
    
    

    快速启动

    带 命令行的

    
    //or you can run in command line
    
    
    $ node_modules/jsdoc/jsdoc.js 
    
    
     --configure node_modules/angular-jsdoc/common/conf.json 
    
    
     --template node_modules/angular-jsdoc/angular-template 
    
    
     --destination build/docs 
    
    
     --readme README.md 
    
    
     --recurse directives services
    
    
     --tutorials tutorials
    
    
    
    

    ,或者使用 Gulp

    
    var shell = require('gulp-shell');
    
    
    gulp.task('docs', shell.task([
    
    
     'node_modules/jsdoc/jsdoc.js '+
    
    
     '-c node_modules/angular-jsdoc/common/conf.json '+//config file
    
    
     '-t node_modules/angular-jsdoc/angular-template '+//template file
    
    
     '-d build/docs '+//output directory
    
    
     './README.md ' +//to include README.md as index contents
    
    
     '-r directives services' +//source code directory
    
    
     '-u tutorials'//tutorials directory
    
    
    ]));
    
    
    
    

    ,或者使用 Grunt

    
    grunt.initConfig({
    
    
     jsdoc: {
    
    
     dist: {
    
    
     src: ['directives', 'services'],
    
    
     options: {
    
    
     destination: 'build/docs',
    
    
     configure: 'node_modules/angular-jsdoc/common/conf.json',
    
    
     template: 'node_modules/angular-jsdoc/angular-template',
    
    
     tutorial: 'tutorials',
    
    
     readme: './README.md'
    
    
     }
    
    
     }
    
    
     }
    
    
    });
    
    
    
    

    标签可用

    • @ngdoc - 指定要记录的内容的类型。 有关详细信息,请参阅 below。
    • @scope - 指定文档化指令所使用范围的类型。 对于新的继承范围,选项为 true,用于共享范围的false,或者用于隔离范围的{} 或者 object。 如果未提供 @scope,则将假定一个新的共享范围
    • @priority - 指定指令的文档优先级
    • @animations - 指定文档指令支持的动画
    • @restrict - 指定如何在用法节中显示指令。 例如对于 [E] lement。[A] ttribute和 [C] gal,使用 @restrict ECA
    • @eventType emit|broadcast - 指定是否发送或者广播事件

    示例

    文档级自定义项

    目前,已经构建了两个模板;

    • 默认值
    • 角度模板( 推荐)

    要添加自己的模板,请将 angular-template 目录复制到你自己的目录,然后制作你自己的css。js和html文件。
    然后,使用模板运行 jsdoc.js 命令。 例如,

    
    $ node_modules/jsdoc/jsdoc.js 
    
    
     --configure node_modules/angular-jsdoc/common/conf.json 
    
    
     --template node_modules/angular-jsdoc/my-template 
    
    
     --destination build/docs 
    
    
     --readme README.md 
    
    
     --recurse directives services
    
    
    
    

    如果你想与他人共享模板,请在添加 angular-template 目录的模板目录中发送一个请求请求。

    以下是带有说明的目录示例:

    
    my-template
    
    
     ├── css
    
    
     │ └── my.css # css used in layout.html
    
    
     ├── js
    
    
     │ └── my.js # javascript used in layout.html
    
    
     ├── fonts
    
    
     │ └── my.woff # font used in layout.html
    
    
     ├── html
    
    
     │ ├── class.html # template used by layout.html
    
    
     │ └── layout.html # layout file
    
    
     └── publish.js # the main file that generate jsdoc
    
    
    
    

    当前默认的角度模板不带有自定义字体。 如果要使用模板模板,但使用自定义字体,请更改 publish.js 中的copyStaticFiles 方法:

    角度模板/发布。js

    // copy the template's static files to outdirvarcopyStaticFiles=function() {
     ['css', 'js'].forEach(function(dirName) {
     var fromDir =path.join(templatePath, dirName);
     var staticFiles =fs.ls(fromDir, 3);
     staticFiles.forEach(function(fileName) {
     var toDir =fs.toDir( fileName.replace(fromDir, path.join(outdir, dirName)) );
     fs.mkPath(toDir);
     fs.copyFileSync(fileName, toDir);
     });
     });
    };

    到:

    为模板/发布

    // copy the template's static files to outdirvarcopyStaticFiles=function() {
     ['css', 'js', 'fonts'].forEach(function(dirName) {
     var fromDir =path.join(templatePath, dirName);
     var staticFiles =fs.ls(fromDir, 3);
     staticFiles.forEach(function(fileName) {
     var toDir =fs.toDir( fileName.replace(fromDir, path.join(outdir, dirName)) );
     fs.mkPath(toDir);
     fs.copyFileSync(fileName, toDir);
     });
     });
    };

    版权

    麻省理工学院许可证


    angular  TEMP  template  Jsdoc  
    相关文章