документация ngdoc для контроллера

Я новичок в документации по коду и пытаюсь документировать свое угловое приложение с помощью 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/ и я не могу понять, почему я продолжаю получать сообщение об ошибке, если я пытаюсь документировать контроллер : (Спасибо за любую помощь!

3 7
javascript angularjs documentation-generation

3 ответа:

Похоже, что в Примере РЕПО есть устаревшая версия grunt-ngdocs, указанная в качестве зависимости. @ngdoc controller поддерживается начиная с 0.2.2, в то время как grunt-ngdocs-example перечисляет ~0.1.1. Используйте последнюю версию grunt-ngdocs, и вы должны быть хорошо идти.

Стоит отметить ,что "официальным" инструментом для создания угловой документации является dgeni + dgeni-пакеты . Он используется угловой 1.x для создания собственной документации. Очень гибкая и расширяемая, хотя настройка может занять некоторое время. время.

Edit я раздвоился grunt-ngdocs-example здесь , обновил версию grunt-ngdocs и добавил пример контроллера.

2

Вот как вы можете документировать образец контроллера: 

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

Используйте dgeni и добавьте пользовательский шаблон контроллера:

  1. создать controller.template.html в config/template/ngdoc/api с содержимым {% extends "api/object.template.html" %} (он будет унаследован от шаблона объекта, но вы можете написать свой собственный шаблон)

  2. Перейдите в свой dgeni config и расширьте 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'
});})
0