Question

我是新手编写代码文档并尝试使用grunt-ngdocs记录我的角度应用程序。

我克隆了一个来自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/，如果我尝试记录控制器，我无法弄清楚为什么会一直收到错误消息:(感谢您的帮助！

Answer 1

以下是如何记录样本控制器：

/**
 * @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
 */

Answer 2

示例repo似乎将grunt-ngdocs的过时版本列为依赖项。从0.2.2开始支持@ngdoc controller，而grunt-ngdocs-example列出〜{0.1}。使用最新的grunt-ngdocs，你应该很高兴。

值得一提的是，用于生成Angular文档的“官方”工具是dgeni + dgeni-packages。 Angular 1.x使用它来生成自己的文档。非常灵活和可扩展，虽然设置可能需要一些时间。

修改我已经分叉grunt-ngdocs-example here，升级了grunt-ngdocs版本并添加了控制器示例。

Answer 3

使用dgeni并添加自定义控制器模板：

使用内容controller.template.html在config/template/ngdoc/api中创建{% extends "api/object.template.html" %}（它将从对象模板继承但您可以编写自己的模板）

转到您的dgeni配置并在idTemplates

中扩展computeIdsProcessor

config(function (computeIdsProcessor) {
computeIdsProcessor.idTemplates.find(function (idTempl) {
    return idTempl.idTemplate === "module:${module}.${docType}:${name}";
}).docTypes.push("controller");})

请务必在"controller"

中加入computePathsProcessor

.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'
});})

控制器的ngdoc文档

3 个答案: