前端代码注释规范

作者:神秘网友 发布时间:2021-11-25 14:06:37

前端代码注释规范

前端代码注释规范

目的和原则

提高可读性和可维护性
如无必要,勿增注释;如有必要,尽量详尽

语法和快捷键

单行注释:// 快捷键: ctrl+/
多行注释:/**/ 快捷键: ctrl+shift+/

规范

1、注释符与注释内容之间加一个空格
2、注释行与上方代码间加一个空行

HTML

顶部文档注释

 /**
  * @description: 中文说明
  * @author: name
  * @update: name(xxxx-xx-xx)
  */

CSS

/* content */
内容
/* end content */

JS

函数

/**
 * @func
 * @todo 这个函数需要优化
 * @desc 一个带参数的函数
 * @param {string} a - 参数a
 * @param {number} b=1 - 参数b默认值为1
 * @param {string} c=1 - 参数c有两种支持的取值/br1—表示x/br2—表示xx
 * @param {object} d - 参数d为一个对象
 * @param {string} d.e - 参数d的e属性
 * @param {string} d.f - 参数d的f属性
 * @param {object[]} g - 参数g为一个对象数组
 * @param {string} g.h - 参数g数组中一项的h属性
 * @param {string} g.i - 参数g数组中一项的i属性
 * @param {string} [j] - 参数j是一个可选参数 
 * @returns {boolean} 返回值为true
 */

本文章教程介绍完毕,更多请访问跳墙网其他文章教程!

前端代码注释规范 相关文章

  1. 常见命名规范及注释规则 -- 前端篇

    常见命名规范及注释规则 -- 前端篇 1、背景 目前在项目文件、样式、变量、函数等等命名没有专门特定的规范,对项目整洁性、可维护性造成一定的影响;对于多人开发多人迭代项目、命名的统一性可方便人员相互快速了解开...

  2. 解析Python代码注释规范代码

    一、代码注释介绍 注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。 注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。 在有处理逻辑的代码中,源...

  3. C代码编写规范注释和格式化

    C代码编写规范:注释和格式化 如果注释的一个函数,可以使用块注释 如果注释函数中的某一个语句,使用单行注释 使用一次 Tap 操作,实现缩进,默认整体向右边移动,使用 shift+tap 整体向左移动 运算符两边习惯各加一个空格...

  4. C# 代码 XML 注释规范及其 .chm 帮助文档生成

    C# 代码 XML 注释规范及其 .chm 帮助文档生成 一.摘要 当我们进行程序开发时,面对一个大型项目,需要多人分工合作,每人实现一个模块。当我们需要调用他人编写的模块时,首先参考的不是源码部分,而是要去通读其代码注释...

  5. 前端代码规范剪辑

    CSS属性书写顺序,建议遵循一下顺序: 1. 布局定位属性: display/position/float/clear/visibility/overflow 2. 自身属性: width/height/margin/padding/border/background 3. 文本属性: color/font/text-decoration/text-align/vertical-align/white-spa

  6. 前端之JS运算符、流程控制、循环、代码规范、数组及函数

    前端之JS运算符、流程控制、循环、代码规范、数组及函数 文章目录 1、运算符(操作符) 1.1、运算符的分类 1.2、算数运算符 1.3、递增和递减运算符 1.4、比较运算符 1.5、逻辑运算符 1.6、赋值运算符 1.7、运算符优先级 2、流程...

  7. 187、js注释规范

    1 、文档注释 /* * * comment */ 2 、模块注释 /* * * 模块说明 * @module 模块名 */ /* * * Core模块提供最基

  8. 微信小程序开发规范文档-JavaScript注释规范

    注释 注释分为单行注释和多行注释。 单行注释以//开头。 // 单行注释示例 多行注释以/ 开始,以 /结束。 /* * 多行注释 * 示例 */ 团队约定 单行注释 一般用于简单的描述,如状态描述,属性描述等。书写时应遵循以下规范: 注...

  9. 使用VA助手如何快速添加注释(按doxygen注释规范)

    使用VA助手如何快速添加注释(按doxygen注释规范) 原文首发于微信公众号「3D视觉工坊」:使用VA助手如何快速添加注释(按doxygen注释规范) 首先,关于VA助手的破解安装教程,请参考:VS2015 Visual Assist X 破解版安装教程 此处分享一...

  10. C#规范类库的注释生成xml类库注释提示文件

    C#规范类库的注释,生成xml类库注释提示文件 当我们创建一个dll给其他人使用时,为了方便,增加合适的注释。这是一种很好的代码规范,应该养成这种生成注释的习惯。 右键 dll类库项目,选择 属性,切换到 “生成” 选项,...

  11. C语言编程基础(1)注释风格编程规范常量变量

    C语言编程基础(1)注释风格、编程规范、常量变量 对于C语言编程者尤其是C语言初学者是否遇到过自己编写的代码几个月之后自己都看不懂了呢?功能实现后回头一看代码显得杂乱无章呢?变量与常量的使用规则是否还有点模...

  12. C语言 - 基于STM32库文件编写符合Doxygen规范的注释

    C语言 - 基于STM32库文件,编写符合Doxygen规范的注释 写了这么多,其实还是不知道怎么去写注释。我们知道stm32库文件是符合库文件标准,那么我们就参照它的注释格式,来编写我们的注释文件。 为了能使代码能够被Doxygen识别,...

  13. 根据 Promise/A+ 和 ES6 规范,实现 Promise 源码(附详细注释和

    Promise 源码 https://github.com/lfp1024/promise promise-a-plus const PENDING = ‘PENDING‘const REJECTED = ‘REJECTED‘const RESOLVED = ‘RESOLVED‘const resolvePromise = (promise2, x, resolve, reject) = { if (promise2 === x) { // ES6 规范

  14. Day 04 Java基础语法(19-26) (注释,数据类型,转义字符,变量,作用域变量命名规范)

    Day 04 (p19 - 26) 编译型和解释型 (19) IDEA 安装 (20) IDE 集成开发环境 可以搜索idea优化,改一些设定 Java 基础语法 注释 (21) 注释用来解释, 注释行并不会被执行, 写给写代码的人看的 写注释是非常好的习惯 ! ! ! 单行注释: // 多行注释: /...

  15. PC工具大神级代码注释漂亮实用的代码注释工具代码logo工具

    【PC工具】大神级代码注释,漂亮实用的代码注释工具代码logo工具 github上看各路大牛大神的项目代码,经常会看到各种神注释 ...... 那么问题就来了:大神是如何在代码里搞的这些图片代码呢? 打死我也不信是大牛大神一个一...

  16. 代码注释:_HTML注释:如何在HTML代码中创建和使用?

    代码注释:_HTML注释:如何在HTML代码中创建和使用? 代码注释: HTML is a very popular scripting or coding language used to create web pages. HTML provides different tags in order to create different units like textbox, color, paragraph, list, e

  17. 前端编程规范 (详细)

    前端编程规范 (详细) 1.Prettier插件 快捷键 shift+alt+f 1.避免单字母的名字。用你的命名来描述功能。 // badfunction q() { // ...}// goodfunction query() { // ...} 2.在命名变量、对象、函数和实例时使用驼峰命名法(camelCase) // badconst OBJEcttss

  18. Web前端开发规范手册

    规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档。 文件规范 文件命名规则 文件名称统一用小写的英文字母、数字和下划线的组合,其中不得包含汉字、空格和特殊...

  19. Web前端开发规范手册

    Web前端开发规范手册 一、规范目的 1.1 概述 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发 人员必须按本文档规范进行前台页面开发. 本文档...

  20. 前端学习修改vscode块注释快捷键

    【前端学习】修改vscode块注释快捷键 step1.界面左下角--点下齿轮--勾选键盘快捷方式(如图) step2.输入“shift+alt+a”进行筛选,再双击方形区域进行更改(如图) 更改的样式:同时按下键盘的几个样式,再按下回车键 我改成了al...

每天更新java,php,javaScript,go,python,nodejs,vue,android,mysql等相关技术教程,教程由网友分享而来,欢迎大家分享IT技术教程到本站,帮助自己同时也帮助他人!

Copyright 2021, All Rights Reserved. Powered by 跳墙网(www.tqwba.com)|网站地图|关键词