7

我是代码文档的新手，并试图用 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/，但我不明白为什么我尝试记录控制器时会不断收到错误消息:(谢谢寻求帮助！

4

3 回答 3

5

以下是记录示例控制器的方法：

/**
 * @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
 */
于 2016-01-11T11:41:14.490 回答
2

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

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

编辑我在grunt-ngdocs-example 这里分叉，升级了grunt-ngdocs版本并添加了一个控制器示例。

于 2015-12-15T22:06:54.427 回答
1

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

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

  2. 转到您的 dgeni 配置并idTemplates扩展computeIdsProcessor

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

  3. 记得包含"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'
});})
于 2017-10-23T08:49:42.410 回答