我應該使用哪一個，grunt-ngdoc或grunt-ngdocs爲我的angularjs應用程序生成api和tutorial doc？

Question

有2個grunt插件用於爲Angularjs應用程序生成文檔。

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維基確實有關於如何寫文檔的一些信息： 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

包咕嚕-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 

但它不影響你的源文件。

不要忘記運行服務器

e.g使用python

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