c# 编码规范和编程好习惯_c#教程

　　谁都会写代码！几个月的编程经验能够让您写出“可运行应用程式”。让他可运行容易，但是以最有效率的方式编码就需要下更多的功夫！

　　要知道，大多数程式员在写“可运行代码，而不是高效代码”。我们在这个指南课程前面提到，您想成为您们公司“最尊贵的专业人员”吗？写“高效代码”是一项艺术，您必须学习和实践他。

　　命名惯例和规范　　

　　注记 :

　　Pascal 大小写形式－任何单词第一个字母大写，其他字母小写。

　　Camel 大小写形式－除了第一个单词，任何单词第一个字母大写，其他字母小写。　　

　　类名使用Pascal 大小写形式

　　public class HelloWorld{ ...}　　

　　方法使用Pascal 大小写形式

　　public class HelloWorld{ void SayHello(string name) { ... }}　　

　　变量和方法参数使用Camel 大小写形式 　　

　　public class HelloWorld{ int totalCount = 0; void SayHello(string name) { string fullMessage = "Hello " name; ... }}

　　不要使用匈牙利方法来命名变量 　　

　　以前，多数程式员喜欢他－把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如：

　　string m_sName;int nAge;

　　然而，这种方式在.NET编码规范中是不推荐的。任何变量都用camel 大小写形式，而不是用数据类型和m_来作前缀。 　　

　　用有意义的，描述性的词语来命名变量 　　

　　- 别用缩写。用name, address, salary等代替 nam, addr, sal

　　- 别使用单个字母的变量象i, n, x 等. 使用 index, temp等

　　用于循环迭代的变量例外：

　　for ( int i = 0; i < count; i ){ ...}

　　假如变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。

　　- 变量名中不使用下划线 (_) 。

　　- 命名空间需按照标准的模式命名

　　...

　　文档名要和类名匹配 　　

　　例如，对于类HelloWorld, 相应的文档名应为 helloworld.cs (或, helloworld.vb)

　　缩进和间隔

　　缩进用 TAB . 不用 SPACES.。

　　注释需和代码对齐.。

　　花括弧 ( {} ) 需和括号外的代码对齐.。

　　用一个空行来分开代码的逻辑分组。. 　　

　　 bool SayHello (string name) { string fullMessage = "Hello " name; DateTime currentTime = DateTime.Now; string message = fullMessage ", the time is : " currentTime.ToShortTimeString(); MessageBox.Show ( message ); if ( ... ) { // Do something // ... return false; } return true; }

　　这段代码看起来比上面的好：:

　　 bool SayHello ( string name ) { string fullMessage = "Hello " name; DateTime currentTime = DateTime.Now; string message = fullMessage ", the time is : " currentTime.ToShortTimeString(); MessageBox.Show ( message ); if ( ... ) { // Do something // ... return false; } return true; }

　　在一个类中，各个方法需用一空行，也只能是一行分开。

　　花括弧需单独一行，而不象if, for 等能够跟括号在同一行。.

　　好：

　　 if ( ... ) { // Do something }

　　不好：

　　 if ( ... ) { // Do something }

　　在每个运算符和括号的前后都空一格。. 　　

　　好：

　　 if ( showResult == true ) { for ( int i = 0; i < 10; i ) { // } }

　　不好：

　　 if(showResult==true) { for(int i= 0;i<10;i ) { // } }

　　良好的编程习惯　　

　　遵从以下良好的习惯以写出好程式 　　　　

　　避免使用大文档。假如一个文档里的代码超过300～400行，必须考虑将代码分开到不同类中。

　　避免写太长的方法。一个典型的方法代码在1～25行之间。假如一个方法发代码超过25行，应该考虑将其分解为不同的方法。

　　方法名需能看出他作什么。别使用会引起误解的名字。假如名字一目了然，就无需用文档来解释方法的功能了。　　

　　好：

　　 void SavePhoneNumber ( string phoneNumber ) { // Save the phone number. }　　

　　不好：

　　 // This method will save the phone number. void SaveData ( string phoneNumber ) { // Save the phone number. }

　　一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务很小。　　

　　好：

　　 // Save the address. SaveAddress ( address ); // Send an email to the supervisor to inform that the address is updated. SendEmail ( address, email ); void SaveAddress ( string address ) { // Save the address. // ... } void SendEmail ( string address, string email ) { // Send an email to inform the supervisor that the address is changed. // ... }　　

　　不好：

　　 // Save address and send an email to the supervisor to inform that the address is updated. SaveAddress ( address, email ); void SaveAddress ( string address, string email ) { // Job 1. // Save the address. // ... // Job 2. // Send an email to inform the supervisor that the address is changed. // ... }

　　使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。　　

　　好：

　　 int age; string name; object contactInfo;　　

　　不好：

　　 Int16 age; String name; Object contactInfo;

　　别在程式中使用固定数值，用常量代替。

　　别用字符串常数。用资源文档。

　　避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。假如在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了他的值。

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有