文档介绍：微软内部代码规范
写在前头
微软内部的代码编写规范,对于我们来说,有时候觉得很没必要,甚至是猜不透为什么要规定这样写,但是,既然微软内部的员工都按照这个规范来编写代码,一定是有自己的原因的
一款名为“StyleCop”的软件,就是用来检查这些规范的,而“Microsoft Source Analysis for C#”则是专门针对C#兼容的工具
安装以上工具之后,你可以在代码编辑器中右击->Run StyleCop,系统就会把所有违反此语法规则的代码以警告方式提醒
你会发现,跟你平常的****惯会有很大出入,如果你觉得自己有一套规范,那你大可以看完这篇后的3秒钟内全部忘掉
本文只写出比较特别的规则,并不是全部规则。
代码放置位置
所有资源(“using ….. ”)要放在命名空间内,如:
namespace HelloWorld
{
using System;
using ;
……
}
文件最开头要带copyright 和 author的标签,如:
// <copyright file="" company="sinners">
// Copyright (C) 2009 sinners. All rights reserved
// </copyright>
// <author>gosion poon</author>
可访问性顺序应该为:public->protected->private
方法成员属性顺序应该为:Fields->Methods->Properties
每个方法成员属性以及类都需要摘要段,摘要不能为空,传入传出参数必须注释且所有摘要和注释不能少于10个字母
构造函数摘要必须以“Initializes a new instance of the 类名 class”开头
属性必须以“Gets or sets a value”开头,而Bool返回值的属性必须以“Gets or sets a value indicating whether”开头
所有代码块必须以“{”和“}”作为开始和结束
If、while、for 等,条件与操作必须分属不同的行
不同条件之间,例如if操作完后面没有跟着else的情况下,后续代码必须在开始空出一行空行
命名规则
变量名不能以“_”开头,不能以类似“m_”形式开头或中间带“_”,个人建议,如果类似常量“MESSAGE_ERROR”形态的,“_”可以用“x”代替,即“MESSAGExERROR”
如果是一般的变量,还是乖乖的用小写字母开头并不带下划线等符号吧。可能你在想:不能以