标签：Person C# 代码 规范 private int protected 命名 public
注释规范
类注释
/// <summary>
/// 老师类
/// </summary>
public class Teacher {}
方法注释
/// <summary>
/// 根据id查找人的名字
/// </summary>
/// <param name="id">人的id</param>
/// <returns>人的名字</returns>
public string GetPersonName(int id)
{
return "";
}
单行注释
// 我是注释
多行注释
/*
多行注释
多行注释
*/
命名规范
基本命名规范
在命名时需要使用有意义的名称
优先使用英文，如果英文没有合适的单词，可以使用拼音，如城市名称等
禁止使用中文命名
命名不能使用缩写，如必须写成 person，不能写成 per
Pascal 风格（单词首字母大写）命名
命名空间
namespace MyApp{}
类
public class Person {}
枚举类型、枚举值
public enum Colors
{
Red = 1,
Green = 2,
Yellow = 3
}
事件
public event WorkEventHandler OnWork;
属性
public string Name { get; set; }
方法
public void Method(){}
常量
const int Value = 10;
Camel 风格（首字母小写，其后每个单词的首字母大写）命名
变量
int name;
int personId;
方法参数
public void Method(int num){}
字段（private 和 protected 字段，需要加“_”前缀）
public class Person
{
private string _name;
}
其他命名规范
接口以 I （大写的 i ）为前缀命名
public interface ISpeak {}
委托以 EventHandler 作为后缀命名
public delegate void WorkEventHandler ();
事件以其对应的委托类型，去掉 EventHandler 后缀，加上 On 前缀
public enent WorkEventHandler OnWork;
抽象类以 Abstract 为前缀或者以 Base 为后缀命名
public abstract class AbstractPerson {}
异常类型以 Exception 为后缀
public class LoginException {}
布局规范
使用 Tab 缩进，缩进大小为 4
Visual Studio 2017 中设置方法：菜单工具-选项-文本编辑器-C#-制表符，把制表符大小和缩进大小设置成4，选中“保留制表符”，点确定。
左右花括号必须独占一行，括号内容为空时可在一行
Visual Studio 2017 中设置方法：菜单工具-选项-文本编辑器-C#-代码样式-格式设置-新行
示例代码
public void Method(int id)
{
int i = 1;
int j = 2;
}
public void Method(int id) {}
编码规范
不能出现公有字段
如果需要公有字段，使用属性包装。
类型名称和源文件名称必须一致
当类型名称是 Person 时，其源文件名称必须是 Person.cs。
类型成员的排列顺序
类型成员的排列顺序自上而下：
字段：private、protected
属性：private、protected、public
事件：private、protected、public
构造函数：参数越多，排的越靠前
方法：参数越多，排的越靠前
示例代码
public class Person
{
private int _field1;
protected int _field2;
private int _property1 { set; get; }
protected int _property2 { set; get; }
public int Property3 { set; get; }
public Person(int param1, int param2) {}
public Person(int param1) {}
public Person() {}
public string GetPersonName(int param1, int param2) {}
public string GetPersonName(int param1) {}
public string GetPersonName() {}
}
标签：Person,C#,代码,规范,private,int,protected,命名,public 来源： https://www.cnblogs.com/xkpbgy/p/16331461.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。