没有合适的资源?快使用搜索试试~ 我知道了~
C#项目命名规范方案范例.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 128 浏览量
2023-04-04
21:35:25
上传
评论
收藏 1.7MB PDF 举报
温馨提示
![preview](https://dl-preview.csdnimg.cn/87651838/0001-33dbf21117a771a4420ef116d9ccbeb7_thumbnail.jpeg)
![preview-icon](https://csdnimg.cn/release/downloadcmsfe/public/img/scale.ab9e0183.png)
试读
24页
。
资源推荐
资源详情
资源评论
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![txt](https://img-home.csdnimg.cn/images/20210720083642.png)
![zip](https://img-home.csdnimg.cn/images/20210720083736.png)
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![](https://csdnimg.cn/release/download_crawler_static/87651838/bg1.jpg)
C#项目开发代码规范
命名规范制定意义
1 方便代码的交流和维护,便于日后自己的再次阅读。
2 不影响编码的效率,不与大众习惯冲突。
3 使代码更美观、阅读更方便。
4 使代码的逻辑更清晰、更易于理解
命名规范制定原则
首要原则
有意义的,描述性的词语来命名。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法
的功能了
1. 除约定俗成的,别用缩写。用 name, address, salary 等代替 nam, addr, sal
2. 除用于循环,别使用单个字母的变量象 i, n, x 等. 而要使用 index, temp 等。
for ( int i = 0; i < count; i++ ){ ...}
其他习惯
除了界面控件外,不要使用类型前缀。比如:使用名称 amount,而不是 intAmount;
类:使用名词、名词短语命名。比如:public class FileStream;
方法:使用动词、动词短语开始。比如:CreateUser(), RemoveAt()等;
接口:以 I 开始,后面加上名词、名词短语、形容词命名。比如:IDisposable;
常量:所有单词大写,多个单词之间用 "_" 隔开。public const string PAGE_TITLE = "Welcome";
命名空间: 基本格式:
![](https://csdnimg.cn/release/download_crawler_static/87651838/bg2.jpg)
CompanyName/ProjectName.TechnologyName[.Feature][.Design]
a) CompanyName/ProjectName:公司名、项目名称或产品名称;
b) TechnologyName:稳定的、公认的技术名称或架构层次名称;
c) [.Feature][.Design]:可选的功能与设计;
C#命名规范
变量方法命名规则
1、用 pascal 规则来命名方法和类.(第一个单词首字母大写,后面连接的每个单词首字母都大写)
public class DataBase ;public void GetDataTable()
2、类:使用名词、名词短语命名。比如:
public
class FileStream;
2.用 camel 规则来命名局部变量和方法的参数. (第一个单词不大写,后面连接的单词首字母大写)
public void AddUser(string userId, byte[] password)
{ string userName;}
3.所有的成员变量前加前缀 _
public class Database
{ private string _connectionString; }
4.接口的名称加前缀 I
interface ICompare
{ int compare(); }
5.自定义代码属性类以 Attribute 结尾
public class OperationAttribute : Attribute
![](https://csdnimg.cn/release/download_crawler_static/87651838/bg3.jpg)
6.自定义的异常以 Exception 结尾
public class AppException : Exception
7.方法的命名.一般将其命名为动宾短语,“动词+对象”.
GetRecordData();GetPath();CreateFile();
8.代码的缩进.要用 Tab,而不要用 space.
9. 使用带有说明性的变量名。
(a)避免单字符串的变量名,使用类似于 index 或 temp 这样有意义的名字。
(b)对于 public 或 protected 类型的变量避免使用匈牙利表示法。
(c)不要缩写单词。
10. 所有的类成员变量应该被声明在类的顶部,并用一个空行把它们和方法以及属性的声明区分开.
11.用有意义的名字命名 namespace,如:产品名、公司名.
12.建议局部变量在最接近使用它时再声明.
13.使用某个控件的值时,尽量命名局部变量.
14.把引用的系统的 namespace 和自定义或第三方的用一个换行把它们分开.
15.文件名要能反应类的内容,最好是和类同名,一个文件中一个类或一组关连类.
16.目录结构中要反应出 namespace 的层次.
17.大括号"{"要新起一行 .
18. 在和你的代码缩进处于同一个级别处为该行代码添加注释
19 单独方法要加注释 字段(一目了然的课一部详细说名)
例如:
/// <summary>
///
![](https://csdnimg.cn/release/download_crawler_static/87651838/bg4.jpg)
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public string GetName(int id){
return “xiaomi“;
}
名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可
以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原则是:
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯
一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请
确保选择的名称符合适用语言的规则和标准。
1以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title。
3、只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4、在变量名中使用互补对,如 min/max、begin/end 和 open/close。
5、布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。
6、在命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使
用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。 (此项只供参考)
7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,
如 i 或 j。 可能的情况下,尽量不要使用原义数字或原义字符串,如
![](https://csdnimg.cn/release/download_crawler_static/87651838/bg5.jpg)
For i = 1 To 7。而是使用命名常数,如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。
8、用于事件处理的委托添加“EventHandler”后缀
9、用于事件处理之外的那些委托添加“Callback”后缀
10、不要给委托添加“Delegate”后缀
11、用名词或名词词组来给类型命名,在少数情况下也可以用形容词词组来给类型命名
12、用动词或动词词组来命名方法
13、用名词、名词词组或形容词来命名属性
14、要用动词或动词短语来命名事件
15、要用名词或名词短语来命名字段
2 小写规则
大写
标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如:
System.IO
System.Web.UI
下表汇总了大写规则,并提供了不同类型的标识符的示例。
标识符 大小写 样例
名字空间 Pascal namespace System.Security { … }
类型 Pascal public class StreamReader { … }
剩余23页未读,继续阅读
资源评论
![avatar-default](https://csdnimg.cn/release/downloadcmsfe/public/img/lazyLogo2.1882d7f4.png)
![avatar](https://profile-avatar.csdnimg.cn/default.jpg!1)
apple_51426592
- 粉丝: 9664
- 资源: 9657
上传资源 快速赚钱
我的内容管理 展开
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助
![voice](https://csdnimg.cn/release/downloadcmsfe/public/img/voice.245cc511.png)
![center-task](https://csdnimg.cn/release/downloadcmsfe/public/img/center-task.c2eda91a.png)
最新资源
- 通信仿真,mseed-process-master.zip
- python,python-scheduling.rar
- python,python-quantum.rar
- python,python-project-euler.rar
- Linux常用命令及用法说明
- 基于Matlab的FFT频谱分析及IIR数字滤波器设计
- AutoCAD高压低压电气开关柜设备接线图图纸
- AutoCAD电气图纸建筑电气开关柜常用cad图纸
- 使用ASP.NET Core和Entity Framework Core来构建一个基本的进销存系统.rar
- 深度学习经典数据集+FER2013面部表情识别+附带使用方法的python代码
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
![feedback](https://img-home.csdnimg.cn/images/20220527035711.png)
![feedback](https://img-home.csdnimg.cn/images/20220527035711.png)
![feedback-tip](https://img-home.csdnimg.cn/images/20220527035111.png)
安全验证
文档复制为VIP权益,开通VIP直接复制
![dialog-icon](https://csdnimg.cn/release/downloadcmsfe/public/img/green-success.6a4acb44.png)