1 / 9
文档名称:

软件开发编码规范.docx

格式:docx   大小:38KB   页数:9页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

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

分享

预览

软件开发编码规范.docx

上传人:秋江孤影 2020/12/22 文件大小:38 KB

下载得到文件列表

软件开发编码规范.docx

相关文档

文档介绍

文档介绍:软件开发编码规范
(C#)
引言 错误!未定义书签。
编写目的 错误!未定义书签。
背景 错误!未定义书签。
定义 错误!未定义书签。
参考资料 错误!未定义书签。
基本要求 错误!未定义书签。
程序结构要求 错误!未定义书签。
可读性要求 错误!未定义书签。
结构化要求 错误!未定义书签。
正确性与容错性要求 错误!未定义书签。
可重用性要求 错误!未定义书签。
用户界面设计原则 错误!未定义书签。
源程序书写规范 错误!未定义书签。
通用源代码格式规则 错误!未定义书签。
缩进 错误!未定义书签。
边距 错误!未定义书签。
“{} ”的使用 错误!未定义书签。
注释 错误!未定义书签。
语句格式与语句书写规范 错误!未定义书签。
括号 错误!未定义书签。
保留字和关键字 错误!未定义书签。
函数 错误!未定义书签。
变量 错误!未定义书签。
语句 错误!未定义书签。
命名规范 错误!未定义书签。
函数命名 错误!未定义书签。
形参 错误!未定义书签。
常量和变量 错误!未定义书签。
常量和宏定义 错误!未定义书签。
变量 错误!未定义书签。
函数使用说明、接口命名、 NameSpace命名 错误!未定义书签。
控件的命名 错误!未定义书签。
类型 错误!未定义书签。
一般类型 错误!未定义书签。
构造类型 错误!未定义书签。
类类型 错误!未定义书签。
文件和文件夹 错误!未定义书签。
文件夹的命名规则 错误!未定义书签。
文件命名 错误!未定义书签。
源程序文档注释规范 错误!未定义书签。
注释文档的一般规范 错误!未定义书签。
1引言
编写目的
本规范旨在用规范文件的形式,对全公司使用 C#S行的编程过程,进行有效的规范
管理,使得最终的软件产品具有良好的风格和统一的结构,且使代码可读性强、易维
护。
本规范预期读者是全公司所有参与编程的软件开发人员以及其他相关人员。
本标准适用于 Visual C# ,其余语言作参考。
背景
公司在上一个项目中由于代码编写风格不统一,可读性较差、较难维护,使得工作
效率有所降低。
定义

参考资料
Pascal Standards FAQ (E)
JavaDoc (E)
Doc-O-matic Document (E)
Artemis Alliance Delphi Coding Standards (E)
« C#@本书写规范》
« C#^码规范纲要》
2基本要求
程序结构要求
程序结构清晰,简单易懂,单个函数的程序行数一般不得超过 100行,个别特殊函数
除外。
代码中打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
(无特殊情况不要使用外部方法调用 windows的核
心动态链接库)。
一般情况下,不得使用全局变量,尽量使用局部变量。
可读性要求
可读性第一,效率第二。(这仅对代码本身而言)。
保持注释与代码完全一致。
每个源程序文件,都必须有文件头说明,说明规格见“源程序文档注释规范” 一节。
每个函数,都必