首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

使用YUIDoc的EmberJS文档,注释样式?

YUIDoc是一个用于生成JavaScript代码文档的工具,而EmberJS是一个用于构建Web应用程序的JavaScript框架。在使用YUIDoc生成EmberJS文档时,可以使用以下注释样式:

  1. 类注释: /**
    • @class ClassName
    • @extends Ember.Object
    • @module moduleName
    • @namespace Namespace
    • @constructor
    • @public */
  • @class:指定类的名称。
  • @extends:指定类的继承关系。
  • @module:指定所属的模块名称。
  • @namespace:指定类所属的命名空间。
  • @constructor:指定类的构造函数。
  • @public:指定类的访问权限为公共。
  1. 属性注释: /**
    • Property description.
    • @property propertyName
    • @type {Type}
    • @default defaultValue
    • @public */
  • @property:指定属性的名称。
  • @type:指定属性的类型。
  • @default:指定属性的默认值。
  • @public:指定属性的访问权限为公共。
  1. 方法注释: /**
    • Method description.
    • @method methodName
    • @param {Type} paramName - Parameter description.
    • @return {Type} Return description.
    • @public */
  • @method:指定方法的名称。
  • @param:指定方法的参数及其描述。
  • @return:指定方法的返回值及其描述。
  • @public:指定方法的访问权限为公共。

这些注释样式可以帮助YUIDoc解析代码并生成相应的文档。在EmberJS中使用YUIDoc生成文档时,可以参考YUIDoc的官方文档(https://yui.github.io/yuidoc/)了解更多详细的用法和配置选项。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

领券