Question

有两个用于为Angularjs应用程序生成文档的grunt插件。

https://www.npmjs.org/package/grunt-ngdoc

https://www.npmjs.org/package/grunt-ngdocs

我应该使用哪种差异？

咕噜-ngdoc


    ngdoc: {
      options: {
        dest: 'docs'
        scripts: ['../app.min.js'],
        html5Mode: true,
        startPage: '/api',
        title: 'My Documentation',
        analytics: {
              account: 'UA-08150815-0',
              domainName: 'my-domain.com'
        },
        discussions: {
              shortName: 'my',
              url: 'http://my-domain.com',
              dev: false
        }
      },
      tutorial: {
        src: ['content/tutorial/*.ngdoc'],
        title: 'Tutorial'
      },
      api: {
        src: ['src/**/*.js', '!src/**/*.spec.js'],
        title: 'API Documentation'
      }
    }

ngdocs


    ngdocs: {
      options: {
        dest: 'docs'
        scripts: ['../app.min.js'],
        html5Mode: true,
        startPage: '/api',
        title: "My Awesome Docs",
        image: "path/to/my/image.png",
        imageLink: "http://my-domain.com",
        titleLink: "/api",
        bestMatch: true,
        analytics: {
              account: 'UA-08150815-0',
              domainName: 'my-domain.com'
        },
        discussions: {
              shortName: 'my',
              url: 'http://my-domain.com',
              dev: false
        }
      },
      tutorial: {
        src: ['content/tutorial/*.ngdoc'],
        title: 'Tutorial'
      },
      api: {
        src: ['src/**/*.js', '!src/**/*.spec.js'],
        title: 'API Documentation'
      }
    }

Answer 1

我今天想知道同样的事情。我注意到ngdocs https://github.com/m7r/grunt-ngdocs正在经历比ngdoc https://github.com/bevacqua/grunt-ngdoc更积极的开发。结果我决定选择ngdocs。

更新：我尝试了两种方法，并且能够让ngdocs为我的项目工作，但无法使ngdoc正常工作。

Answer 2

grunt-docular还有AngularJS' style生成文档。但是几个月没有任何活动:(对我来说，看起来有点团队从那以后做了一些改进，但仅限于内部使用

Answer 3

嗯，AngularJS wiki确实有一些关于如何编写文档的信息： https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation

AngularJS使用的jsdoc的味道称为ngdo c，由名为Dgeni的Node.js实用程序解析。

此处有关Dgeni的更多信息：https://github.com/angular/dgeni

Answer 4

包grunt-ngdocs https://github.com/m7r/grunt-ngdocs工作正常（但很长时间没有更新）

对于ng1.6适用于我：

ngdocs: {
  all: ['app/**/*.js']
}

你会在

中看到角度1.2。*的旧版本

cat docs/js/angular.min.js  | grep v1
 AngularJS v1.2.16

但它不会影响您的源文件。

不要忘记运行服务器

例如使用python

pushd ./dist; python -m SimpleHTTPServer 9000; popd #v 2.*
pushd ./dist; python -m http.server 9000; popd #v 3.*

我应该使用哪一个，grunt-ngdoc或grunt-ngdocs为我的angularjs应用程序生成api和教程文档？

4 个答案: