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

【问题标题】：which one should I use, grunt-ngdoc or grunt-ngdocs to generate the api and tutorial doc for my angularjs app?我应该使用哪个，grunt-ngdoc 或 grunt-ngdocs 来为我的 angularjs 应用程序生成 api 和教程文档？
【发布时间】：2014-04-23 19:01:23
【问题描述】：

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

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

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

有什么区别，我应该使用哪一个？

咕噜-ngdoc

ngdoc：{ 选项： { 目的地：'文档' 脚本：['../app.min.js']， html5模式：真， startPage: '/api', 标题：“我的文档”，分析：{ 帐户：'UA-08150815-0'，域名：'my-domain.com' }, 讨论：{ shortName: '我的', url: 'http://my-domain.com', 开发：假 } }, 教程： { src: ['content/tutorial/*.ngdoc'], 标题：'教程' }, 接口：{ src: ['src/**/*.js', '!src/**/*.spec.js'], 标题：'API 文档' } }

ngdocs

ngdocs：{ 选项： { 目的地：'文档' 脚本：['../app.min.js']， html5模式：真， startPage: '/api', 标题：“我的真棒文档”，图片：“路径/到/我的/image.png”， imageLink: "http://my-domain.com", 标题链接：“/api”，最佳匹配：真，分析：{ 帐户：'UA-08150815-0'，域名：'my-domain.com' }, 讨论：{ shortName: '我的', url: 'http://my-domain.com', 开发：假 } }, 教程： { src: ['content/tutorial/*.ngdoc'], 标题：'教程' }, 接口：{ src: ['src/**/*.js', '!src/**/*.spec.js'], 标题：'API 文档' } }

【问题讨论】：

有 4-5 个 npm 模块用于生成角度文档，您应该更新您的帖子；-)。或者更具体地提出问题并写下您正在搜索生成角度文档的 grunt-plugin，那么至少有 3 个插件。
使用 ng-docs。这是官方的。

标签： gruntjs

【解决方案1】：

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

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

【讨论】：

+1 我对grunt-ngdoc 有同样的经历。我认为那个项目可能会失败。不过，grunt-ngdocs 可以工作并且看起来很巴拉。
对我来说也一样，ngdoc 总是“生成 0 个页面”。
这个包对于 ng1.6 和 ng2 来说太旧了

【解决方案2】：

还有grunt-docular 在AngularJS' style 中生成文档。但是几个月没有活动:(在我看来，Angular 团队从那时起做了一些改进，但仅供内部使用

【讨论】：

我来晚了，但我还没准备好放弃 grunt-docular。它使您可以轻松地将 Angular 文档与您的项目文档放在一起，在通勤时拥有非常好。
不管怎样，我的公司已经介入，我们现在正在赞助文档项目。该网站应该会在接下来的几天内备份，并且会有一个公司维护人员和一群渴望做出贡献的人。

【解决方案3】：

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

AngularJS 使用的jsdoc 风格称为ngdoc，由名为Dgeni 的Node.js 实用程序解析。

更多关于Dgeni的信息在这里：https://github.com/angular/dgeni

【讨论】：

是的，是的。但这在使用方面的文档很差。
我也有同样的经历。

【解决方案4】：

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

ng1.6 适合我：

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

你会在

中看到旧版本的angular 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.*

【讨论】：