算法设计与分析第一章作业

[计科2101 杨康]

一般公司的代码规范

一 命名空间

<公司名称>.(<产品名称>|<相关技术>)[.<用途>] [.<子命名空间>]

二 代码风格

• 花括号“{}”不允许省略，即使只有一段代码。
• 不允许省略访问修饰符。
• 类型默认是密封的。
• 不允许公开字段。
• 使用括号“()”来强调运算符优先级。

三 命名规范

（一） 类、结构和接口的命名

 

（四） 常量、变量的命名

 

（五） 枚举的命名

 

（六） 资源的命名

 

（七） 数据库命名

 

（八） XML命名

节点名称使用Pascal风格，属性名称使用Camel风格。

四 注释

• 使用名词或名词短语。
• 使用Pascal方式。
• 在接口名称前加上前缀“I”。
• 考虑在派生类末尾使用基类的名字。
• 如果该类仅仅为了实现某个接口，那么请保持其与接口命名的统一
• （三） 参数的命名
• Camel风格。
• 要使用left和right来命名重载的二元操作符的参数——如果参数没有具体的含义。
• 要使用value来命名重载的一元操作符的参数——如果参数没有具体的含义。
• 不要在参数中使用数字编号。
• 尽量使用描述性的名字命名泛型类型参数，并在前面使用“T”前缀。
• 常量——所有单词大写并用“_”分隔。
• 局部变量——Camel风格。
• Pascal风格。
• 使用名词的复数形式来命名标记枚举。
• 不要添加“Enum”或“Flag”后缀。
• 不要给枚举类型值的名字加前缀。
• Pascal风格。
• 仅使用字母、数字和下划线。
• 在命名异常消息的资源时，资源标识符应该是异常类型名加上简短的异常标识符。
• 表——“模块名_表名”。
• 字段——bool类型用“Is”、“Can”、“Has”等表示；日期类型命名必须包含“Date”；时间类型必须包含“Time”。
• 存储过程——使用“proc_”前缀。
• 视图——使用“view_”前缀。
• 触发器——使用“trig_”前缀。
• 对接口和复杂代码块必须进行注释。
• 修改代码时保持注释同步。
• 未完成的功能使用TODO标记。
• 修改他人代码时要先注释对方代码，并写明修改原因，不允许随便删除他人代码。
• 发布前移除无用注释。

 

 

 

    数学之美读后感  ：  一般