Chinaunix首页 | 论坛 | 博客
  • 博客访问: 12876772
  • 博文数量: 1293
  • 博客积分: 13501
  • 博客等级: 上将
  • 技术积分: 17974
  • 用 户 组: 普通用户
  • 注册时间: 2011-03-08 18:11
文章分类

全部博文(1293)

文章存档

2019年(1)

2018年(1)

2016年(118)

2015年(257)

2014年(128)

2013年(222)

2012年(229)

2011年(337)

分类: 系统运维

2012-08-14 17:39:29


  代码风格乱如三国,代码注释千奇百怪,让人无法接受与阅读。C\C++\c#\qt\Java\vb等这些大语言们,得想法个规范其注释。


  得出下面的千古规范:


1、单行注释

   因为注释文字不多,尽量建议放在代码行的右边,增加代码可阅读性。


(1) 注释放在右边,"//" 注释符类型

string AppStartupPath;           // 取得应用程序的路径 

(2)注释放在右边," /* */ " 注释符类型

this.dataGridView1.Rows.RemoveAt(0);  /*  删除单元格 */



                        图1 避免注释影响代码可阅读性

2、多行注释

/*

*    这

*    是多行注释

*/


3、注释放在要注释语句的上面时,其上面使用空行隔开,避免拥挤。


image

                                 图2 我的注释样式举例


image

                              图3 VS2008最佳显示字体与大小


4、代码语句之间,满四句就空两格


  1. [DllImport("kernel32")]

  2.         private static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);

  3.         [DllImport("kernel32")]

  4.         private static extern int GetPrivateProfileString(string section, string key, string def, byte[] bufferRe, uint size, string filePath);



  5.         public string RemoteIP;

  6.         public int RemotePort;

  7.         public begin Begin;

  8.         public Register register;



  9.         public delegate void RefreshLabel();

  10.         private List<string> InternalInfoList;

  11.         private List<string> DynamicMessList;

  12.         private BackgroundWorker InitialSystemWorker;

5、上、下函数之间,空三格


  1. private void funA()
  2. {
  3. ///
  4. }

  5. /** 这里请空三格*/

  6. private void funB()
  7. {
  8. ///
  9. }


阅读(2671) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~