【规范】前端编码规范——注释规范
2017-02-13 17:15
381 查看
文件申明
顶部添加文件申明信息,包括文件描述、原始作者,如果有更新,则需要添加更新内容、更新作者和更新时间。/** * @description: 说明文字 * @author: 张三 */ /** * @description: 说明文字 * @author: 张三 * @update: 更新内容 by 李四 2013-04-13 18:32 */
单行注释与多行注释
无论是单行注释还是多行注释,注释中的每一行长度都不能超过 40 个汉字,或者 80 个英文字符。单行注释
/* this is a short comment */
多行注释
/* * this is comment line 1. * this is comment line 2. */
函数或方法注释
/** * 这是一个求和函数 * @param {Number} a 第一个数字 * @param {Number} b 第二个数字 * @return {Number} 返回两个数字之和 */ var sum = function(a, b) { return a + b; }
模块注释
模块注释必须单独写在一行。/* 模块:xxxxxx by 张三 */ ... /* 模块:xxxxxx by 张三 */
样式区块注释
/* header */ ... /* footer */ ... /* banner */ ...
相关文章推荐
- 前端编码规范之CSS
- [调查]如果你是个讲求编码规范的程序员,而碰到给变量、方法随意命名,注释又混乱的同事时你会怎么处理???
- java编码规范和代码注释
- 前端开发编码规范之CSS
- 由一段代码谈前端js优化和编码规范(一) 分类: JavaScript 2015-03-21 12:43 668人阅读 评论(1) 收藏
- 《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释
- 3.7 代码注释和编码规范
- 前端读者 | 百度前端编码规范(HTML)
- eclipse和myeclips自动生成编码规范注释(xml导入)
- 前端开发规范之html编码规范
- 理解学习PHP编码规范之注释和文件结构
- 前端编码规范,个人感觉bootstrap总结的不错,拿出来给大家分享
- 网易前端JavaScript编码规范
- 由一段代码谈前端js优化和编码规范(一)
- 前端读者 | 百度前端编码规范(CSS)
- 前端编码规范之CSS
- 团队项目开发"编码规范"之三:程序注释
- 【规范】前端编码规范——css 规范
- 前端编码规范之JavaScript
- 前端编码规范,个人感觉bootstrap总结的不错,拿出来给大家分享