常用注释标签

作者: 沃土前端社区_子鸣 | 来源:发表于2018-03-03 09:31 被阅读0次
前言

在工作中,团队开发,为了代码的维护性,常要求写注释,现分享一些常用注释标签

注释用法

vscode为例:

输入:/** 然后回车就可以自动生成一个注释代码块了,然后在注释块里面输入@标签:描述

image.png
常用标签总结
@author:作者
@class:类
@callback:回调
@constructor:类的回调函数
@classdesc:类描述
@const:常量
@default:默认值
@desc:描述
@example:举例
@name:名称:用于抽象方法或匿名函数
@param:参数
@arg:参数
@argument:参数
@property|@prop:属性
@requires:依赖
@return 返回
@type 类型
使用
image.png

这个类我增加了这些注释,一个方便阅读理解。另外一个:


image.png

你在引用的时候它就会把注释直接调取出来了

相关文章

  • 前端Day - 01

    HTML 标签 单标签 换行符 标签对 常用标签对 注释 CSS 层叠样式表 标...

  • HTML+CSS部分知识

    1.标签 常用的单标签 < !— xx –>:注释标签 快捷键:ALT+/ < br/>:换行标签 注释:自动生成...

  • 常用注释标签

    前言 在工作中,团队开发,为了代码的维护性,常要求写注释,现分享一些常用注释标签 注释用法 以vscode为例: ...

  • Android常用注释标签

    Bolg - 常用注释标签 创建文件注释模版 Preferences -- Editor -- File and ...

  • HTML笔记-文字标签和注释标签

    HTML笔记-文字标签和注释标签 标签(空格分隔): HTML HTML中常用的标签 文字标签: 修改文字的样式 ...

  • html常用标签

    Html 大纲 html知识目录 什么是网页,网页的注释 网页的结构和标签 常用的标签和标签的属性 html5常用...

  • Javadoc 标签记录

    因为经常要写注释, 所以记录一下常用的标签

  • 《日子》.使用 Intellij Idea 导出JavaDoc

    使用/** ...... */来注释代码,解释方法参数,返回参数,类的功能及用法.常用的注释标签: @author...

  • Django模板标签

    知识点: 基本概念 常用标签 模板标签例子 模板继承与应用 注释标签 模板文件路径设置 模板标签 标签在渲染的过程...

  • HTML中的元素使用方法2——零基础自学网页制作

    HTML常用元素使用练习2 NO.3: 注释标签是为代码添加注释使用的,它的内容不会显示在页面中...

网友评论

    本文标题:常用注释标签

    本文链接:https://www.haomeiwen.com/subject/wpctfftx.html