1 / 15
文档名称:

代码书写标准(推荐).doc

格式:doc   页数:15页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

代码书写标准(推荐).doc

上传人:875845154 2016/2/14 文件大小:0 KB

下载得到文件列表

代码书写标准(推荐).doc

相关文档

文档介绍

文档介绍:C#书写规范准则:第一章:(包括小,大,中括号)的内侧应紧靠操作数或者其他运算符,、Finalize函数,字段,属性,方法,事件,委托的类型顺序排列尽可能将相关性强的成员排列在一起。私有字段和属性访问器写在一起通常静态方法在前,实例方法在后。其中国各方法的相互顺序与属性情况类似,既可以根据逻辑关系排列,也可以根据字母顺序排列。对于方法的重载,应放一起。并根据参数的数量由简到繁排列。公开方法之后依次排列的应为事件,委托,对接口的显示实现等。直至给出所有公开成员之后,才是受保护成员与私有成员。#,循环结构的注释方法先在前面说明意图,然后在方法体里每个条件再说明具体的条件说明。,,或者是在函数体内的篇幅较长的注释文本。为了突出它的注释性质,我们建议使用这样的格式:/**这是一段很长很长的注释文本*这是一个。。*/或者/**********************************************对萨达打算分的打三分********************************************/,都应该带有XML文档注释,比便通过智能感知系统向开发人员提供及时的参考信息。这些必要的位置包括:所有公开的类型,这类型的所有公开的和受保护的成员,这些成员所涉及到得所有参数,返回值,基坑内抛出的异常。///<summary>///表示一副图片///</summary>我们只需在summary标签中描述该类型的用途下面的几种描述方式都是较好的。——表示。。。。。。。如果该结构或类是真实世界中的某个物体或抽象概念的直接反映,且其名称本身足以让人理解他的主要用途时——提供。。。。。。如果该结构或类的功能更倾向于提供某种功能或者服务,或者本身的抽象概念名称无法清晰表达他的主要用途时——包含。。。。。有些类型本身并没有包含功能,它的主要目的就是提供对其他一些工具或对象的访问,。用于描述这个属性的作用如果属性是即可读又可写的,那么以“获取或设置。。。”的方式进行描述。对于只读属性,则应该使用“获取。。。”的描述方式。bool类型或枚举类型的属性上,用“获取或设置一个值,该值表示。。。。。”,还要用param标签为每个参数进行详细说明,用return标签描述函数的返回值///<summary>///返回制定图片文件的艺术家信息///</summary>///<paramname=“filename”>要检索的照片文件名</param>///<return>返回指定图像文件的艺术家信息,如果没有找到,则返回空引用。</return>summary标记用动宾结构的短语描述,如果主要目的是为了获取某个特定的值,用“返回。。。”的句式。Param采用偏正结构的短语清晰描述该参数在整个函数方法中的功能及影响Return详细解释其所有可能的返回值以及代表的含义。,可采用一些模式化的表达方式:——初始化。。。。。类的