CSharpJava代码编写规范.pdfVIP

代码规范 基本代码规范 1、 异常处理模式，每个函数都要求使用 try-catch ，catch 的结果都输送到 Console 2 、 If 、switch 代码段都需要使用 {}括起来，即使只有一句代码 3 、 字符串的比较需要使用 Equals，不能直接使用 == 4 、 添加引用时，把拷贝到本地设置为 false 5 、 一个函数里面，返回出口只有一个，如果中间有分支，采用变量记录需要返回的结 果，在最后统一返回 修改前代码： if (index -1 index Commands.Count) { returnthis.Commands[index] as IBaseItem 。 } else { return null 。 } 修改后代码： IBaseItem item = null 。 try { item = Commands[index] as IBaseItem 。 } catch (Exception ex) { Appliction.ActiveApplication.Output.Output(ex.Message) 。 } return item 。 6 、 成员字段的初始化，包括需要 new 的成员变量，都在统一的一个函数或者相应的构造 函数里面进行，不要在外面直接 new 7 、 事件参数和事件代理类型的声明和实现均放到实现该事件的类型里面去 8 、 内部使用的全局字段，需要以 g_大头，后面第一个单词字母大写，即后面按照函数名 的命名方式进行 9 、 Form 或者 UserControl 的界面成员变量和局部变量的名称的命名规则是： [m_] + 要 素类型（第一个英文字符小写） +名称（第一个字符要大写），即界面类成员变量的命名规 则在原来的基础上增加界面要素类型。举例原来命名为 m_workspaceName ，如果这个变量 的类型为 TextBox ，则重新命名为 m_textBoxWorkspaceName ；注意，此规则只限于界面要 素成员变量即局部变量，其他类型变量命名规则不变。 10、 资源命名时，根据资源的不同类型在前面添加前缀，比如字符 Resources.String_， 图片 Resources.Image_等等 11、 所有流程图 VSD 文件中的字体均采用微软雅黑字体，其中流程图中的字号为 9 号 字。所有流程图中均要给出流程图的名称和作者名称。 1 / 9 12、 单个函数的代码行数不能超过 100 行（从函数定义开始到结束的大括弧）。 13、 函数缩进等级不能超过 5 级。 14、 所有字符串不允许硬编码（直接在程序中写死），必须提取中字符串资源。 编码风格规范 C# 花括号的使用 1. 避免把左花括号放在前一条语句的末尾 . 如 : if(someExpression){ DoSomething() 。 } 2. 要把右花括号放在新一行的开始处。如： if