四时宝库

程序员的知识宝库

代码注释的主要规则,仅4点(代码注释的重要性)

点击右上方红色按钮关注“小郑搞码事”,每天都能学到知识,搞懂一个问题!

注释的主要规则如下

1. 公共组件和各栏目的维护者都需要在文件头部加上注释说明

/**

* 文件用途说明

* 作者姓名

* 联系方式

* 制作日期

**/

2. 大的模块注释方法

//==========

// 代码用途

//==========

3. 小的注释

// 代码用途

4. 注意注释单占一行

// 姓名

var name = "abc";

// 不要像下面这样

var name = "abc"; // 姓名

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言
    友情链接