代码风格乱如三国,代码注释千奇百怪,让人无法接受与阅读。C\C++\c#\qt\Java\vb等这些大语言们,得想法个规范其注释。
得出下面的千古规范:
1、单行注释
因为注释文字不多,尽量建议放在代码行的右边,增加代码可阅读性。
(1) 注释放在右边,"//" 注释符类型
string AppStartupPath; // 取得应用程序的路径
(2)注释放在右边," /* */ " 注释符类型
this.dataGridView1.Rows.RemoveAt(0); /* 删除单元格 */
图1 避免注释影响代码可阅读性
2、多行注释
/*
* 这
* 是多行注释
*/
3、注释放在要注释语句的上面时,其上面使用空行隔开,避免拥挤。
图2 我的注释样式举例
图3 VS2008最佳显示字体与大小
4、代码语句之间,满四句就空两格
- [DllImport("kernel32")]
- private static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);
- [DllImport("kernel32")]
- private static extern int GetPrivateProfileString(string section, string key, string def, byte[] bufferRe, uint size, string filePath);
- public string RemoteIP;
- public int RemotePort;
- public begin Begin;
- public Register register;
- public delegate void RefreshLabel();
- private List<string> InternalInfoList;
- private List<string> DynamicMessList;
- private BackgroundWorker InitialSystemWorker;
5、上、下函数之间,空三格
- private void funA()
- {
- ///
- }
- /** 这里请空三格*/
- private void funB()
- {
- ///
- }
阅读(2669) | 评论(0) | 转发(0) |