我为何拒绝撰写注释内容？

本文共计1007个文字，预计阅读时间需要5分钟。

事实上，没有人问过我为什么没有写注释，我也没有向别人解释过不写注释的原因。但最近有人在我耳边说，你们这些程序员为什么都不写注释。所以我觉得有必要解释一下。

其实没有人问过我为什么不写注释，我也没有向别人说过我不写注释的原因。但是最近一直有人在我耳边说，你们这些鸟人为什么都不写注释了。所以我觉得我有必要做一下解释了。

第一、什么情况下需要注释。如果你面对的受众是一些初学者或者非专业的人员，那么确实需要写注释，这一点在教科书上体现的最多。又或者，你所工作的语言是结构化编程之类的没有很强的层次性（包或者命名空间）和封装（类），那么你需要写注释(C是最好的例子）。最后，如果你写的是算法，或者你的函数中有魔数之类的东西，你需要加注释，比如如果你有一个函数如下，那么你最好写一些注释

publicstringGetRequestFile(){
if(String.IsNullOrEmpty(Request.QueryString["fileName"]))
returnmagicFileName;//你可能需要说明为什么会返回这样一个文件名
normalprocedure....
}

。

第二、为什么我不写注释。首先我面对的是专业的人员，大家都是做软件的，没有可能看不懂。其次，现在项目的语言是C#，面向对象的，具有很好的封装性，一个类的代码行数不会很多（因为职责单一）。最后函数和类是自说明的是比较简小的，理解起来也没有什么困难（我写的函数一般不超过10行，如果异常处理多一点也就20行，函数名和类名也符合规范，类一般不超过150行）。

第三、为什么会要求注释。1、程序写的很不好，函数和类名没有自说明（或者由于语言导致的，比如C）。2、代码阅读人员对业务不熟悉（建议先熟悉业务，因为业务是根本，技术只是实现而已）。