javascript - 使用 ngdocs 时指令的 templateUrl

Question

我正在尝试设置 ngdocs对于我们公司的项目。作为初学者，我认为我应该为我们的指令之一设置一个示例。

我有 ngdocs 这样工作，它生成文档等等。我想知道的是，在使用 ngdocs 时应该如何为指令提供模板？我的搜索没有发现任何关于此的内容。这有点讽刺(文档工具缺少文档)。

因此，我生成文档的代码如下所示

(function (angular) {
   'use strict';

   /**
    * @ngdoc directive
    * @name EA.directive:ssn
    * @restrict E
    * @scope
    * @param {object} value The value to check for a valid ssn. This is double-binded. You will most likely want this like 'value="vm.ssn"'.
    *
    * @description
    * Textfield that gives only allows valid organisationnumbers and SSNs.
    * Checks everything except the last 4 chars.
    * The last four can be either all numbers, or 'TF##'.
    *
    * @example
    <example module="ea">
    <file name="index.html">
    <div ng-controller="SampleCtrl as vm">
      <ssn value="vm.ssn"></ssn>
    </div>
    </file>

    <file name="script.js">
    function SampleCtrl(){
      var vm = this;
      vm.ssn = "";
    }
    angular.module("ssnSample", ["ea"])
      .controller("SampleCtrl", SampleCtrl);
    </file>
    </example>
    */

   function ssn(){
      var ssnController = function(){
         var vm = this;
         init();

         function init() {
            if (vm.organisation !== undefined) {
               vm.uiMask = "?999999-9999";
               vm.pattern = /^(\d{10})$/;
               vm.errorText = "Ange ett giltigt organisationsnummer (XXXXXX-XXXX).";
            } else {
               vm.uiMask = "?99999999-**99";
               vm.pattern = /^[1-2][0,9]\d{2}([0][1-9]|[1][0-2])([0][1-9]|[1-2][0-9]|[3][0-1])(\d{4}|TF\d{2})$/;
               vm.errorText = "Ange ett giltigt personnummer (YYYYMMDD-XXXX).";
            }
         }

      };

      return {
         restrict: 'E',
         templateUrl: 'src/directives/ssn/ssn.html',
         uiMask: "",
         pattern: "",
         errorText: "",
         minLength: 0,
         scope: {
            eaClass: "@",
            value: '=',
            organisation: '@',
            blur: '&'
         },
         controller: ssnController,
         controllerAs: 'vm',
         bindToController: true
      };
   }
   angular.module('ea')
      .directive('ssn', ssn);
})(angular);

但是结果好像没有接我的<ssn>元素。

这是一个plnkr以指令本身为例。它不包括 ui-mask 部分，但如您所见，该指令有效。

当我生成 ng-docs 时，使用的路径是什么？我的文档结构是这样的:

src
|--directives
   |--ssn
      |--ssn.js
      |--ssn.html

所以在我的 templateUrl:我应该放什么？根据 ngdocs，什么是有效的？

这是它当前显示方式的图片:

如您所见，整个“演示”部分是空白的，不应该是这样。它应该包含我的 <ssn>元素，实际上只是一个包装的 <input>具有奇特的功能。

建议？

编辑

问了一个多星期了，还没有答案。到目前为止，我已经尝试过 ng-docs , ng-doc , 和 Dokular .没有工作。AngularJS 的文档真的就这么死了吗？

Answer 1

您在查看文档页面时是否检查过控制台？另外，您在构建模板文件时是否将它们部署到“docs”文件夹？我怀疑您的 ssn.html 没有在正确的位置找到 [应该能够内联它以进行验证]。