CSharpJava代码编写规范.docx

代码规范基本代码规范异常处理模式，每个函数都要求使用try-catch，catch的结果都输送到ConsoleIf、switch代码段都需要使用{}括起来，即使只有一句代码字符串的比较需要使用Equals，不能直接使用==添加引用时，把拷贝到本地设置为false一个函数里面，返回出口只有一个，如果中间有分支，采用变量记录需要返回的结果，在最后统一返回修改前代码：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;成员字段的初始化，包括需要new的成员变量，都在统一的一个函数或者相应的构造函数里面进行，不要在外面直接new事件参数和事件代理类型的声明和实现均放到实现该事件的类型里面去内部使用的全局字段，需要以g_大头，后面第一个单词字母大写，即后面按照函数名的命名方式进行Form或者UserControl的界面成员变量和局部变量的名称的命名规则是：[m_] + 要素类型（第一个英文字符小写）+名称（第一个字符要大写），即界面类成员变量的命名规则在原来的基础上增加界面要素类型。举例原来命名为m_workspaceName，如果这个变量的类型为TextBox，则重新命名为m_textBoxWorkspaceName；注意，此规则只限于界面要素成员变量即局部变量，其他类型变量命名规则不变。资源命名时，根据资源的不同类型在前面添加前缀，比如字符Resources.String_，图片Resources.Image_等等所有流程图VSD文件中的字体均采用微软雅黑字体，其中流程图中的字号为9号字。所有流程图中均要给出流程图的名称和作者名称。单个函数的代码行数不能超过100行（从函数定义开始到结束的大括弧）。函数缩进等级不能超过5级。所有字符串不允许硬编码（直接在程序中写死），必须提取中字符串资源。编码风格规范C#花括号的使用避免把左花括号放在前一条语句的末尾. 如:if(someExpression){DoSomething();}要把右花括号放在新一行的开始处。如：if(someExpression){DoSomething();}考虑把只有一条语句的get，set属性代码块和左右花括号放在同一行中。如：public String Name{get{ return m_name; }set{m_name = value; }}避免省略花括号。如：if(someExpression) DoSomething();或if(someExpression)DoSomething();空格的使用要在形式参数和实际参数之间的逗号后加一个空格。如：public void Fun(Char bar, Int32 x, Int32 y)Fun(‘a’, 20, 30);避免在左圆括号之后或是右圆括号之前加空格。如：Fun(‘a’, 20, 30 );缩进的使用要对代码块中的内容进行缩进。如：if(someExpression){DoSomething();}要用制表符(tab)来进行缩进，而不是四个连续的空格来进行缩进.类型使用要用CLR通用的类型名，不要使用语言特有的别名。要使用System.Int64，不要使用C#的long；使用System.Int32,而不要使用C#的int。编码命名规范在给代码中的任何事物命名时，最基本的原则是名称能尽可能表达它的用途。不如类名，要能表达出类型的职责，变量名应该能表达出它的用途。在此规范中C#,C++/CLI主要采用以下两种命名方式：PascalCasing命名方式，要求把每个单词的首字母（包括长度为两个字符以上的首字母缩写单词）大写。如PropertyDescriptor，HtmlTag。camelCasing命名方式，要求除了第一个单词之外的所有单词首字母大写。如propertyDescriptor，htmlTag。C#基本原则要为标识符选择易于阅读的名字要更看中可读性，而不是更看中简短性。CanScrollH