angularjs - 使用 ngDoc 记录一个常量

Question

如何使用 ngDoc 记录一个常量？我没有看到任何 Angular 特定的文档来记录使用 .constant 注册的值，并且常量的 jsDoc 语法在通过 ngDoc 运行时似乎不会生成任何实际的文档。

前任:

/**
* @constant
* @name WHITE
*
* @description
* The color white!
**/
module.constant( 'WHITE', '#fff' );


Answer 1

ngDocs 目前不提供记录常量的方法。正如您在其 templating source code 中所见.没有相关的html_usage_*方法。

我像这样记录常量，然后将 APP_CONFIG 显示为模块。

/**
 * @ngdoc object
 * @name APP_CONFIG
 * @description
 *   constant...
 * @example
 * APP_CONFIG is injectable as constant (as a service even to .config())
 * <pre>
 * (...)    .config(function ($APP_CONFIG) {
 * </pre>
 */