2015-08-27 26 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