首页
学习
活动
专区
工具
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/)了解更多详细的用法和配置选项。

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

相关·内容

如何查看jsplumb.jsAPI文档(YUIdoc基本使用)

2.使用npm install yuidocjs -g 或yarn global add yuidocjs全局安装文档工具YUIdoc 3.进入刚才下载工程目录中/doc/api文件夹 4.打开cmd...YUIdoc默认样式生成离线文档: ?...jsdoc风格注释语句转换成静态网站式离线文档,所以你可以通过定制模板来为最终生成文档增加不同主题样式。...,例如你工程是基于Typescript开发,就可以使用yuidoc ....如果你开发是一个工具库,需要生成完备API文档,为了不影响源码阅读和开发,可以像jsplumb.js那样将注释语句单独写在一个文件中,因为是一个自动化工具,也没什么太多可讲,有需要朋友直接浏览一下官网就可以很容易地使用

2.1K00
  • Xcode文档注释使用总结

    Xcode作为iOS开发神器,为我们提供了十分丰富文档提示功能,在开发过程中,我们可以十分方便按下Option键,选中一个类或者方法查看其文档说明。...而实际开发过程中我们也可以使用规范方法添加注释,达到这样效果。本篇主要介绍几种常用文档注释方法。 多行注释文档 /** 多行注释文档相比于普通多行注释多了一个星号。.../// ///hello swift /// - 这里使用了无序列表 /// - 使用加粗 **this**, 使用斜体 _this_ /// - 添加一个链接: [百度](http://www.baidu.com...这里写图片描述 ---- 标签注释 标签注释穿插在我们代码任意位置,我们通过xcode类视图来查找标签,可以快速定位,十分方便,常见三种注释标签如下: //MARK: - 在代码某处添加一个标签...这里写图片描述 ---- 算法注释 算法是相对比较复杂方法,我们通过注释对其进行详尽说明,其文档注释使用关键字如下: /// - Precondition: 前置条件 /// -

    2.3K40

    java文档注释报错,java文档注释主要使用方法「建议收藏」

    这个也就是我们所知文档注释 在命名控制台:使用命令行在目标文件所在目录输入javadoc +文件名.java。...JAVA 文档注释,类说明,HTML说明文档生成 有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用. 所以我们需要做一个类说明文档....说明注释允许你在程序中嵌入关于程序信息.你可以使用javadoc … Java-Runoob-高级教程:Java 文档注释 ylbtech-Java-Runoob-高级教程:Java 文档注释 1.返回顶部...:Java语言类源文件 … 如何为我们程序编写开发文档——Java文档注释 Java文档注释是用于生成Java API文档注释,通过在程序中类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮...注意,文档注释只说明紧跟其后 … java文档注释–javadoc用法 1.前言 Java中有三种注释方式.前两种分别是 // 和 /* */,主要用于代码注释,以此来方便代码可读性.第三种被称作说明注释文档注释

    83320

    java文档注释符号_java注释符号

    注释真正作用是: 它可以向任何阅读代码的人描述或者解释程序实现思路,如何使用以及其它任何相关信息, 提高代码可读性,方便后期维护与复用。 Java注释有3种: 1....快捷方式: 可以输入” /* ”之后按回车添加注释 3. 文档注释: 一般用来注释类和方法,通过注释内容来记录类或者方法信息. 格式: 以” /** ”开头。...我是一个文档注释/DOC注释 * 我也可以注释多行内容 * 除此之外,我还可以添加一些作者/时间/版本...信息 */ public static void main(String[] args)...m;//小转大,右面的m是小类型,给左面的n大类型赋值,可以直接使用 float f = 3.2f; double d = f; –>可以执行 4.2 大到小(显式转换) 容量大类型转换为容量小类型时必须使用强制类型转换...【强制】代码中命名严禁使用拼音与英文混合方式,更不允许直接使用中文方式。 说明:正确英文拼写和语法可以让阅读者易于理解,避免歧义。 注意,即使纯拼音命名方式也要避免采用。

    10.3K21

    如何注释文档-doxygen版

    首先,Doxygen在不做任何额外工作下可以很容易地把我们代码生成相应HTML格式文档。然而,你也可以通过嵌入类似如何使用你声明过用法注释使之更有用。...学习DoxygenC++注释方法很容易。有很多注释格式可以被Doxygen认同,参见Doxygen官网,尤其是这个部分,当然也仅仅是一个子集而已。..., 2) 针对类成员和参数,注释也可以在其后面, 3) 注释有两种方式:简单(一行)或者详细或者两者都有, 4) 把类型代码注释(类和用法描述)放在.h文件里,而不是在实现文件(.cxx...代码前详细注释 加一个额外‘*’ /** This is a method that does so * much that I must write an epic * novel just...代码前详细注释 加额外‘*<’ void DoNothing(); /**< This is a method that does so * much that I must write

    78220

    Lua生成LDoc文档注释规范

    , 除非使用了(unless –all) @see 引用文档其他内容, 同一模块的话直接 @see xxx, 不同模块的话需要加上模块名 @see xxmodule.xxfunc @usage...以上几个标签都是描述function一些行为 @table 描述一个table, 也可以不加, 只需要给table加上—注释就可以...., 默认是 doc colon 使用冒号风格代替 @ 风格 tag boilerplate 忽略所有源文件中首个注释(块), 比如: license 注释. ext 输出文件后缀(默认为 html...) one 文档使用单列布局 style, template 指定模板和样式目录....在 config.ld 中它也可以为 true , 表示使用和配置文件同一目录模板. merge 允许文档从不同文件合并同名 module , 而不是产生多个module.

    4K10

    Kotlin 文档注释生成-Dokka 1.6.0

    注意:生成前提条件是在源代码中规范进行了文档注释 2.规则 API帮助文档是要给别人看,一般是非私有的属性和函数以及类和接口等提供文档注释。...而私有化接口等,主要是内部使用可以不用文档注释 3.注释 什么是文档注释呢?在Kotlin语法中注释分为三种: 单行注释使用 //在行首进行添加。...一般是给看得到源码的人阅读 多行注释使用/*...*/ 进行注释。一般是给看得到源码的人阅读 文档注释使用/**...*/ 进行注释。一般是给看不到源码的人阅读。...例如类文档注释: /** *版权所有:xxxxxx *许可信息查看:xxxxx * 描述 * 实现功能介绍 *历史版本: * 2020-08-23 :xxxx * */ 等等信息 4.标签注解 我们在使用注释过程中...5.生成注释文档 Kotlin注释文档生成需要使用一个Dokka工具进行:https://github.com/Kotlin/dokka Dokka支持java和Kotlin混合项目生成KDoc文档

    55110

    Eclipse 快捷键以及文档注释、多行注释快捷键

    +/会加上//注释 2.先把你要注释东西选中,用shit+ctrl+/ 会加上/* */注释 3.以上快捷在重复按一下就会去掉加上注释 4.要修改在eclispe中命令快捷键方式我们只需进入...windows -> preference -> General -> key设置就行了 二、Eclipse中添加文档注释快捷键 1.例如默认文档注释:        /**          *...@author  XX          *          */ 2.快捷键为:ALT + SHIFT +J 3.修改文档注释注释格式内容,修改方法有两种: A.直接在eclipse给模板下进行修改...Ctrl+\ Java编辑器 注释 Ctrl+/ Java编辑器 添加导入 Ctrl+Shift+M Java编辑器 组织导入 Ctrl+Shift+O Java编辑器 使用try/catch...也可以使用Ctrl+1自动修正。

    3.5K20

    EclipseMyEclipse快捷键以及文档注释、多行注释快捷键

    一、多行注释快捷键   1.选中你要加注释区域,用 Ctrl+Shift+C 或者 Ctrl+/ 会加上 // 注释,再重复按一下就会去掉 // 注释。...(.js文件中只有 Ctrl+Shift+C 管用,.java文件中都管用)   2.选中你要加注释区域,用 Ctrl+shit+/  会加上 /*...*/ 注释,再用 Ctrl+shit+\  会去掉...(注意:正斜杠是加注释,反斜杠是去掉注释)   3.要修改在eclispe中命令快捷键方式我们只需进入 Windows -> Preferences -> General -> keys 设置就行。...二、Eclipse中添加文档注释快捷键   1.例如默认文档注释:     /**        * @author xxx     *      *      */   2.快捷键为:Alt+Shift...+J   3.修改文档注释注释格式内容,修改方法有两种: A.直接在eclipse给模板下进行修改     打开Eclipse Window --> Preferences --> Java

    4.2K30

    apiDoc构建源代码注释接口文档

    RESTful web API Documentation Generator. http://apidocjs.com 入门 前言 本文档所有示例都使用Javadoc-Style(可用于C...如果没有该指标,apiDoc解析器会忽略文档块。 唯一例外是由@apiDefine它们定义文档块 ,它们不是必需@api。...@apiDefine 每块只能使用一次 通过使用@apiUse定义块将被导入,或者使用标题和描述名称将被使用。 用于定义可重用文档块。该块可以包含在普通api文档块中。...使用@apiDefine允许您更好地组织复杂文档并避免复制经常性块。 定义块可以包含所有的参数(像@apiParam),除了其他定义块。...如果sampleUrl已设置并且您不想使用测试表单方法,请将其添加@apiSampleRequest off到文档块中。

    1.8K20

    DOC文档注释,让你代码如此清晰。

    那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象,但是并不熟悉,加上没有很强烈要去使用意图,所以一直没有弄。今天要感谢公司大神,大家都叫他欧神,神一样男人。...让我用文档注释。然后就知道怎么弄了,以下是生成流程。 2.生成方法 先说生成方法吧,免得一开始将注释规范可能读者觉得比较繁琐,而且注释规范基本上大家都有一套自己做法。...,默认选择是public,建议选择private Destination:生成文档路径 2.2点击下一步 这一页配置基本上全部选择默认,也可以根据自己尿性勾选必要东西 这里也可以导入自己样式文件...3.doc注释 3.1多行注释 对于属性,方法,类注释必须使用多行注释,单行注释不会生成到文档中 3.2属性注释: /** 员工ID */ private String workerId; 3.3方法注释...see和@link都可以链接到指定对象注释文档页面,具体区别使用一次之后就一目了然了,同时@see和@link后面的对象也是需要导包,不导包的话就使用全局限定名,如@see java.util.List

    1.5K40

    annovar注释进阶使用

    菜鸟团公众号肯定讲过annovar使用了。比如Nickiervcf文件注释及ANNOVAR使用。 而在使用 ANNOVAR 之前,你应该知道和ANNOVAR 是如何注释 RS ID ?...annovar最常使用方式是这样。...其实annovar提供了对indel不进行处理方式,-keepindelref参数。 但是很怪,这个参数不能在table_annovar.pl里直接使用,所以注释分成更规范两步。...多样本 直接使用table_annovar.pl注释多样本vcf时,会产生Otherinfo列非常多问题。...添加自有数据库 官方数据库列表包含了很多常用数据库,但是有时候会需要一些比较特殊信息。比如亚洲人群MAF信息。 在找到数据之后,就想利用annovar注释机制将此信息也添加到注释结果中去。

    3.5K40

    Ant+JSDocTookit生成Javascript文档

    : 由于生成文档页面默认是UTF-8,所以源文件应该也是UTF-8编码。...有兴趣可以看看《可爱 Python: 使用 setuptools 孵化 Python egg》。...复制其bin目录下example.bat文件,重命名为test.bat,然后用记事本或其他编辑器打开并配置它: SET yuidoc_home="D:\yui\yuidoc" REM YUI...支持中文注释解决方案 下载最新版本YUI Doc,解决方案在yuidoc-27中验证通过 把所有.js文件都转成不带BOMUTF-8编码 修改文件/bin/yuidoc_highlight.py...谢谢小马提供中文注释解决方案 学会使用工具仅仅是开始了一小步,仔细看看YUI Doc官方文档吧,利用其来促使我们写出更高效优雅前端代码并惠及更多的人才是一大步。

    88430

    【5】Vscode Todo Tree插件使用和TODO、FIXME和XXX注释使用说明以及自制自己TODO图标样式

    1.Vscode Todo Tree插件安装 在vscode扩展中心,搜索 todo tree 然后安装, Todo Tree插件会有自带icon图标样式,如下图: 2.TODO、FIXME和XXX...注释使用说明 TODO: + 说明: 如果代码中有该标识,说明在标识处有功能代码待编写,待实现功能在说明中会简略说明。...XXX: + 说明: 如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现方法有待商榷,希望将来能改进,要改进地方会在说明中简略说明。...方法三:点击左下角设置按钮点击设置 进入和方法二一样界面,点击右上角json文件也可以进入settings.json 3.2 设置自己todo tree注释样式 我自己样式图标仅供参考...background:是指关键字代码中背景色 opacity:透明度 icon:图标样式 iconColour:目录树区域图标颜色 icon:网址提供 https://microsoft.github.io

    2.7K20

    如何用Python快速优雅批量修改Word文档样式

    之前讲过很多基于Excel数据及样式调整案例,今天分享一个Python操作Word真实自动化需求实现过程: 「使用Python批量修改Word样式」 主要将涉及 os模块综合应用 glob模块综合应用...docx模块读写Word文档样式修改 二、需求描述 手上现有若干份财务分析报告Word文档,如下: 每一份Word文档内容如下: 为了方便后续审阅,需要将所有文档中所有含有资金语句标红加粗,...Word文档一般而言由文档(document) - 段落(paragraph) - 文字块(run) 三级结构组成: 从需求反馈中可以看出,本质上我们需要做就是对所有含有资金文字块Run进行样式调整...Word文档,这点跟操作Excelopenpyxl不太一样,有机会再做介绍。...当然除了调整Word字体颜色,其他大多数样式调整都可以使用Python完成,也可以与Excel和PPT结合,这些就留给读者自己开发。

    5.2K20
    领券