c#注释代码的13技巧

《c#注释代码的13技巧》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、1.Commenteachlevel（每个级别的注释有统一的风格）¾Ciwww.netcsharp.cnAÝ2`v$@注释每一个代码块，并且在各个级别的代码块上，要使用统一的注释方法。例如：¾Ciwww.netcsharp.cnAÝ2`v$@·对于类，应包含简单的描述、作者以及最近的更改日期·对于方法，应包含目的的描述、功能、参数以及返回值使用统一的注释规则对于一个团队是非常重要的。当然，更加推荐使用注释的约定和工具（例如，C#的XML或Java的Javadoc），它们会是注释变得更加容易。¾Ciwww.netcsharp.cnAÝ2`v

2、$@2.Useparagraphcomments（对段落注释）¾Ciwww.netcsharp.cnAÝ2`v$@将代码块分成若干完成独立功能的“段落”，并在每个“段落”前添加注释，向读者说明“即将发生什么”。¾Ciwww.netcsharp.cnAÝ2`v$@//Checkthatalldatarecords¾Ciwww.netcsharp.cnAÝ2`”v$@//arecorrect›—¾€Ciwww.netcsharp.cnAÝ2`”v$@foreach(Recordrecordinrecords)›—¾€Ciwww

3、.netcsharp.cnAÝ2`”v$@{›—¾€Ciwww.netcsharp.cnAÝ2`”v$@  if(rec.checkStatus()==Status.OK)›—¾€Ciwww.netcsharp.cnAÝ2`”v$@  {›—¾€Ciwww.netcsharp.cnAÝ2`”v$@    ...›—¾€Ciwww.netcsharp.cnAÝ2`”v$@  }›—¾€Ciwww.netcsharp.cnAÝ2`”v$@}›—¾€Ciwww.netcsharp.cnAÝ2`”v$@//Now

4、webegintoperform›—¾€Ciwww.netcsharp.cnAÝ2`”v$@//transactions›—¾€Ciwww.netcsharp.cnAÝ2`v$@Contextctx=newApplicationContext();¾Ciwww.netcsharp.cnAÝ2`v$@ctx.BeginTransaction();¾Ciwww.netcsharp.cnAÝ2`v$@...¾Ciwww.netcsharp.cnAÝ2`v$@3.Aligncommentsinconsecutivelines（

5、对齐注释行）¾Ciwww.netcsharp.cnAÝ2`v$@对于拥有后缀式注释的多行代码，排版注释代码，使各行注释对齐到同一列。¾Ciwww.netcsharp.cnAÝ2`v$@constMAX_ITEMS=10;//maximumnumberofpackets¾Ciwww.netcsharp.cnAÝ2`v$@constMASK=0x1F;  //maskbitTCP¾Ciwww.netcsharp.cnAÝ2`v$@一些开发人员使用tab来对齐注释，有些则使用空格。但是由于tab在不同的编辑器或者IDE上会有所不同，最

6、好还是使用空格。¾Ciwww.netcsharp.cnAÝ2`v$@4.Don'tinsultthereader'sintelligence（不要侮辱读者的智商）¾Ciwww.netcsharp.cnAÝ2`v$@不要写没用的注释，例如：¾Ciwww.netcsharp.cnAÝ2`v$@if(a==5)   //ifaequals5¾Ciwww.netcsharp.cnAÝ2`v$@  counter=0;//setthecountertozero¾Ciwww.netcsharp.cnAÝ2`v$@写这种无用的注释不

7、但浪费你的时间，而且读者在读这种很容易理解的代码时，很容易被你的注释转移注意力，浪费了时间。¾Ciwww.netcsharp.cnAÝ2`v$@5.Bepolite（要有礼貌）¾Ciwww.netcsharp.cnAÝ2`v$@不要写不礼貌的注释代码，例如“注意，愚蠢的使用者输入了一个负数”，或者“修正由于最初的开发者的可怜且愚蠢的编码所造成的副作用”。这样的注释冒犯了作者，而且你并不知道谁会在将来读到这段注释——你老板、客户或者是你在注释中冒犯的那个可怜且愚蠢的开发人员。¾Ciwww.netcsharp.cnAÝ2`v