原创力文档- 1、本文档共14页，可阅读全部内容。
- 2、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。
- 3、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
- 5、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
- 6、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
- 7、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 8、VIP文档为合作方或网友上传，每下载1次， 网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
软件开发规(C#)
文档名称软件开发规初稿
描述
编写人员
审核人
版本日期
文档变更历史
时间修改人章节描述
目录
1.目的1
2.围2
3.注释规2
4.命名总体规则3
5.命名规4
6.编码规则8
7.编程准则10
8.代码包规11
9.源代码的管理12
10.输入控制校验规则12
11.数据库开发规则12
1.目的
为了统一公司软件开发的设计过程中关于代码编写时的编写规和具体开发工作时的编
程规，保证代码的一致性，便于交流和维护，特制定此规。
2.围
本规适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3.注释规
3.1.概述
a)注释要求中文及中文的标点符号。
b)注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c)每行注释的最大长度为100个字符。
d)将注释与注释分隔符用一个空格分开。
e)不允许给注释加外框。
f)编码的同时书写注释。
g)重要变量必须有注释。
h)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个空格。
如：
stringtitle;//标题
i)典型算法必须有注释。
j)在循环和逻辑分支地方的上行必须就近书写注释。
k)程序段或语句的注释在程序段或语句的上一行
l)在代码交付之前，必须删掉临时的或无关的注释。
m)为便于阅读代码，每行代码的长度应少于100个字符。
3.3.模块（类）注释
模块开始必须以以下形式书写模块注释：
///summary
///说明：对此类的描述，可以引用系统设计中的描述
///作者：作者中文名
///创建时间：格式：YYYY-MM-DD
////summary
///修改记录：
///2012-01-01修改人名称修改功能描述
///2012-01-02修改人名称修改功能描述
///2012-01-03修改人名称修改功能描述
publicclassOrder
{
}
3.4.类属性注释
在类的属性必须以以下格式编写属性注释：
///summary
///属性说明
////summary
publicDateTimeAddTime;
3.5.方法注释
在类的方法声明前必须以以下格式编写注释
///summary
///方法说明
////summary
///参数说明/param
///returns对方法返回值的说明，该说明必须明确说明返回的值代表什么含义/returns
///修改记录：
///2012-01-01修改人名称修改描述
///2012-01-02修改人名称修改描述
///2012-01-03修改人名称修改描述
publicintAdd(OrderInfomodel)
{
}
3.6.代码间注释
代码间注释分为单行注释和多行注释：
单行注释：
//单行注释
多行注释：
/*
多行注释
文档评论（0）