2015-08-27 22 views
0

有没有办法像引导程序中的某些模板一样制作我的应用程序/项目的角度引导文档?如何制作我自己的角度自举文档

+0

是的使用ng-docs你可以评论你的代码和ng-docs创建html文件显示像控制器方法的东西函数的例子https:// github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation – stackg91

+0

好的,这听起来很不错,只是我不知道现在热的访问,我安装ngdoc和gdeni,但我不完全明白如何实行 ? Tnx – profir

回答

0

基本上你需要的是当你有,你可以评论你的代码水木清华这样

/** 
* @ngdoc object 
* @name SomeName 
* @description 
* 
* Some Text 
* 
* <h2>Screenshot</h2> 
* <img src="SomeImage" style="width:200px; border:1px solid grey" alt="login" /> 
*/ 

.controller('someName'...... 

}]) 

,当你有所有你要做的就是上运行咕噜ngdocs通过通过NPM NPM和繁重的安装ng-docs您命令行,它应该建立哪些,那么你可以查看像一个本地服务器上的网页上的实况项目(XAMPP例如),或者把它放到网上

这里是实况链接,一些更多的信息

ng-docs docu

,这里是它的外观

Screenshot

的文件夹需要寻找水木清华这样

- someFolder 
    - ThisisyourProjectFolder 
    - node-modules 
    - docs 
    - package.json 
    - Gruntfile.js 

而且在你去somefolder和运行咕噜ngdocs命令行截图

+0

aha ok,现在我知道,只有缺少的是当我安装全球dgeni上我需要明星命令行的文件我尝试dgeni package.json但结果是 'module.js:338 throw err; ^ 错误:在Function.Module._resolveFilename找不到模块 '的package.json' (module.js:336:15) ... ' – profir

+0

你需要在你的项目 – stackg91

+0

someProjectFolder的根目录进行安装在那里你有package.json,docs文件夹,节点模块,gruntfile.js和你的项目文件夹其中包含你的索引文件 – stackg91