本规范为编写高效可靠C#代码的标准指南,基于安全可靠的软件工程原则,旨在提升代码可读性、可维护性和团队协作效率。
适用于C#项目,包含详细设计、代码编写与审核阶段。
规则 | 示例 |
---|---|
Tab长度设为4个空格 | 禁用实际Tab字符,配置IDE自动转换 |
运算符两侧添加空格 | int sum = a + b; (正确) |
方法参数逗号后空格 | void SaveData(string name, int age) |
类型转换添加空格 | var num = (int) value; |
// 长表达式换行(操作符后换行,缩进一级)
var result = CalculateTotalPrice(items,
discountRate,
taxRate);
// 每行不超过120字符(可配置IDE提示)
// 大括号单独成行
public class Player
{
// 字段与方法间空一行
private int _health;
public void TakeDamage(int damage)
{
// 逻辑块间空一行
if (damage > 0)
{
_health -= damage;
}
}
}
类型 | 规则 | 示例 |
---|---|---|
类/结构体 | PascalCase + 名词 | GameManager |
接口 | I 前缀 + PascalCase |
ICharacterController |
方法 | PascalCase + 动词 | CalculateScore() |
私有字段 | _ 前缀 + camelCase |
_playerName |
常量 | 全大写 + 下划线 | MAX_HEALTH |
禁止项:
• 匈牙利命名法(strName
, iCount
)