末了，如果你写的是算法，或者你的函数中有魔数之类的东西，你须要加注释，比如如果你有一个函数如下，那么你最好写一些注释
public string GetRequestFile(){ if(String.IsNullOrEmpty(Request.QueryString[\"大众fileName\"大众])) return magicFileName;//你可能须要解释为什么会返回这样一个文件名 normal procedure....} 第二、为什么我不写注释。
首先我面对的是专业的职员，大家都是做软件的，没有可能看不懂。其次，现在项目的措辞是C#，面向工具的，具有很好的封装性，一个类的代码行数不会很多（由于职责单一）。末了函数和类是自解释的是比较简小的，理解起来也没有什么困难（我写的函数一样平常不超过10行，如果非常处理多一点也就20行，函数名和类名也符合规范，类一样平常不超过150行）。
1、程序写的很不好，函数和类名没有自解释（或者由于措辞导致的，比如C）。
2、代码阅读职员对业务不熟习（建议先熟习业务，由于业务是根本，技能只是实现而已）。
3、代码阅读职员能力有限或者自身的经历导致了须要由注释看起。
而哀求我写注释的人属于第三的3。他本身是由PHP转过来的，而且其代码风格是纯粹的面向过程的，写的程序很多注释，但是也很长，常常一个页面下来也就1两个函数搞定，300行是家常便饭。因此他阅读程序养成了一个很不好的习气的便是总是要全部把程序看完，才可以理清楚这个类是做什么的（类名和函数名对他来说都是浮云，GetRequestFile和GetResponeFile对他该当没有什么差异）。
而很多时候我们看代码，第一个便是看类名，其次便是看被调用的函数的名称（公共方法），一样平常情形下，已经足够判断这个类是做什么的，还有供应的什么功能（如果弗成，你可以跟类的作者说，重构一下吧，哥看得苦）。这里就哀求我们写代码的时候要像写诗一样去写，就算弗成，最少也要做到代码的自阐明。因此如果你也是一个谢绝写注释的人，那么你写的代码知足第一和第二吗？
末了被哀求注释的类大概是这样的。
class UserAuth{ public bool UserLoginAsClient(){ ...... } public bool UserLoginAsManager(){ ...... } another private function}
练手项目源码、新技能先容、事理性知识、运用框架知识点讲解、常见笔试口试题剖析，搜索【Java知音】
