注释不宜过头

原创 2001年06月21日 00:29:00

我一个同学,称自己的每一句代码都有注释,并以此为荣。

其实,注释的目的是什么呢?是为了别人接手这个程序时,能很快理解程序;或者长时间之后,帮助自己回忆。

我不知道现在有多少程序员在开始写代码之前,会认认真真的对程序进行设计。是理清了头绪再敲键盘,还是不管三七二十一,写了,然后再拼命调试,拼命改……

良好设计的代码脉络清晰,模块划分合理,每个模块的逻辑足够简单。阅读这样的代码就如同阅读小说一样顺畅,代码本身说明了一切!注释完全是多余,画蛇添足!

你见过这样的小说吗?每一段边上都再加一段文字说明这一段小说写了什么(评点本除外)。小说只有开头会有一个概要的介绍。

注释也一样,不需要对代码注释,需要注释的只是某一个模块的说明。

如果自认为目前达不到“良好设计”的水准,可以先多写一些注释,也没关系的,但不要以此为荣,让自己有一个努力的方向,总比既无注释,设计又糟糕好得多。

总之,优良的设计+良好的代码风格=较少的注释

当你发现不得不写很多注释的时候,这时就是检查自己设计是否合理的时机。

myeclipse中java文件头注释格式设置

myeclipse中java文件头注释格式设置(转载http://www.blogjava.net/yxhxj2006/archive/2014/01/14/408940.html) myecl...
  • ruanjian11110
  • ruanjian11110
  • 2016年02月02日 14:25
  • 2222

Android Studio添加代码头注释使用总结

前言: 当我们创建一个文件时,一般文件的头部都会生成一定的注释信息,但有时这些注释信息过于简单,并不能满足我们自己的需求, 这时就需要我们来进行一个定制了 效果图: /** * ...
  • u010661782
  • u010661782
  • 2016年09月08日 01:21
  • 2094

Unity VS脚本自动添加头部注释

很多人一起可能都使用过VS或者Eclipse之类的IDE来开发,都使用过在脚本的头部添加注释,标注时间,作者,修改等等的信息。 那么在Unity中使用MonoBehavior或者VS的时候怎么来实现这...
  • qq563129582
  • qq563129582
  • 2016年08月26日 11:52
  • 2687

VS2005插件——文件头的注释

  • 2011年09月08日 13:58
  • 22KB
  • 下载

批量替换程序的文件注释头

  • 2015年04月16日 15:22
  • 14KB
  • 下载

python批量添加文件头注释

  • 2014年08月08日 10:11
  • 4KB
  • 下载

bash 脚本编程一 文件头,注释 和 变量

必须在脚本文件开头写下:#!/bin/bash意思是这是一个bash shell脚本,而不是其他流行的脚本文件。调用一个基本的Linux命令,echo "hello,world"保存为test.sh文...
  • sheismylife
  • sheismylife
  • 2012年09月12日 16:56
  • 7126

Visual Studio-新建一个cs文件时自动添加region块和自动添加头注释

在visual stuido中新建一个cs文件时,如果您想自动实现添加文件头部,自动添加#region #endregion这种模块机制,实现如下图所示的效果,您知道如何修改吗?...
  • daigualu
  • daigualu
  • 2017年03月22日 14:58
  • 867

【VB.NET】如何自动生成类头注释

最近在机房重构遇到了很多的问题,同时也看了师哥师姐的博客,发现好多师哥师姐的类前面都有注释,当时在想如果每个类都是这么敲上去得多麻烦啊,所以就果断百度了一下,确实有不少相关的博客。所以这里对如何为自动...
  • lxd8731247769
  • lxd8731247769
  • 2015年11月07日 10:07
  • 1332

给VS2010自动设置模板,加头注释

很多程序员都会需要头注释。。比如说作者是谁之类的。。。首先你找到你自己的 VS2010安装目录右键点搜索输入关键字Class.zip 搜出来最终打开Class.cs 编辑加上注释。。。保存。。就OK以...
  • kimizhou_blog
  • kimizhou_blog
  • 2011年03月03日 19:10
  • 11641
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:注释不宜过头
举报原因:
原因补充:

(最多只允许输入30个字)