课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
相信大家在学习软件编程开发的时候也发现了,新手程序员在学习代码格式规范上会有非常严格的要求,下面我们就一起来了解一下代码格式规范都包含了哪些内容。
代码格式规范主要的目的是统一代码编写格式,避免开发人员独特的代码编写方式,以便于项目的所有开发人员能快速的阅读其他人员开发的代码,代码格式规范主要有以下几个方面:
注:除以下规范外,对于一个工程来说应该还有工程结构规范(也可以理解为代码目录结构规范),工程结构规范可能因项目不同而不同,但是统一规范可以提高代码查找效率和开发效率(团队新成员不会再疑惑代码应该放哪里)。
命名规范
命名规范主要涉及命名空间、类型、接口、属性、方法、变量等相关命名,其主要规范有:
使用Pascal(单词字母大写)命名方式对命名空间、类型、枚举类型、枚举值、事件、属性、方法、常量进行命名。
例:public class PersonManager {}
使用Camel()命名方式对参数、变量、字段进行命名。
例:private string userName;
禁止使用缩写,除URL、IO等能达成共识的缩写除外,使用缩写可全大写。
例:System.IO;
接口以I做为前缀进行命名。
例:public interface IConvertor {}
抽象类以Abstract为前缀或者以Base为后缀进行命名。
例:public abstract class PersonBase {}
异常类型以Exception为后缀。
例:public class CustomException {}
在对任何东西命名时需要使用有意义的名称,并且保证单词拼写正确以及语法正确,避免使用拼音(地名等通用拼音除外)。
例: public string Name {get; set;}
反例: public string N {get; set;}
布局规范
布局规范的目的是使代码变得整洁,提高代码可读性,其主要规范有:
代码缩进为4个空格。
注释规范
注释用来对编写的代码进行说明,包括功能说明以及实现说明,这样可以大大的提高程序的可读性,另外规范的注释还可以通过工具来生成相应的API文档
【免责声明】本文系本网编辑部分转载,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如涉及作品内容、版权和其它问题,请在30日内与管理员联系,我们会予以更改或删除相关文章,以保证您的权益!