我是代码文档的新手,并试图用grunt ngdocs来记录我的angular应用程序。
我从中克隆了一个工作示例:https://github.com/m7r/grunt-ngdocs-example
给定的例子缺少一个文档控制器,所以我添加了我自己的文档控制器,代码是:
/**
* @ngdoc controller
* @name rfx.controller:testCtrl
* @description
* Description of controller.
*/
.controller('testCtrl', function() {
});
当我试图通过从命令行运行grunt来构建文档时,我得到以下错误消息:
Warning: Don't know how to format @ngdoc: controller Use --force to continue.
我该如何解决这个问题?我读过这本指南http://www.shristitechlabs.com/adding-automatic-documentation-for-angularjs-apps/我不明白为什么如果我试图记录控制器,我会不断收到错误消息:(感谢您的帮助!
以下是如何记录示例控制器:
/**
* @ngdoc function
* @name appModernizationApp.controller:DetailsCtrl
* @description
* # DetailsCtrl
* Controller of the appModernizationApp
* This controller is responsible for showing the details of the page.
* It gets initialized by requesting the JSON for types of rooms which is hosted on the server.
* It also requests for the details of the room for an existing reservation if the reservation id is present in the route using <b>HRS.getRegisteredData(reservationId)</b>.
* @requires $scope
* @requires $http
* @requires HRS
* @requires $location
* @requires $routeParams
* @requires breadcrumbs
* @requires UtilitiesService
*
* @property {object} breadcrumbs:object breadcrumbs Handles the page level/navigation at the top.
* @property {array} reservationDetails:array This holds the reservation details of the current/selected reservation.
* @property {string} registerationErrorMsg:string This variable holds the error message for all registration services.
* @property {string} roomSearchErrorMsg:string This variable holds the error message for all room search services.
* @property {array} roomDetails:array This holds the room details object. This will be a fresh object coming from service response and will be manipulated as per the view model.
* @property {boolean} submitted:boolean Holds the submitted boolean flag. Initialized with false. Changes to true when we store the details.
* @property {number} reservationId:number Gets the reservation id from the route params.
* @property {date} minDate:date Date filled in the minimum date vatiable
* @property {boolean} isRoomDetailsVisible:boolean Controls the boolean flag for visibility of room details. Initialized with false.
* @property {array} roomTypes:array Holds types of rooms from JSON.
* @property {array} expirymonth:array Months from Jan to Dec
* @property {array} expiryYear:array Years of a particular range
* @property {array} cardtype:array Type of cards
*/
示例repo似乎有一个过时的grunt-ngdocs
版本列为依赖项。从0.2.2开始支持@ngdoc controller
,而grunt-ngdocs-example
列出了~0.1.1。使用最新的grunt-ngdocs
,你应该可以出发了。
值得一提的是,生成Angular文档的"官方"工具是dgeni+dgeni包。Angular 1.x使用它来生成自己的文档。非常灵活和可扩展,尽管设置可能需要一些时间。
编辑我在这里分叉了grunt-ngdocs-example
,升级了grunt-ngdocs
版本,并添加了一个控制器示例。
使用dgeni并添加自定义控制器模板:
- 在
config/template/ngdoc/api
中创建内容为{% extends "api/object.template.html" %}
的controller.template.html
(它将继承自对象模板,但您可以编写自己的模板) -
转到您的dgeni配置并在
computeIdsProcessor
中扩展idTemplates
config(function (computeIdsProcessor) { computeIdsProcessor.idTemplates.find(function (idTempl) { return idTempl.idTemplate === "module:${module}.${docType}:${name}"; }).docTypes.push("controller");})
-
记住在
computePathsProcessor
中包含"controller"
.config(function (computePathsProcessor) { computePathsProcessor.pathTemplates.push({ docTypes: ['provider', 'service', 'directive', 'input', 'object', 'function', 'filter', 'type', 'controller'], pathTemplate: '${area}/${module}/${docType}/${name}', outputPathTemplate: 'partials/${area}/${module}/${docType}/${name}.html' });})