ISO软件开发全套文档 项目编码规范编写指南
项目编码规范编写指南
项目编码规范1 命名规范1）.包名采用域后缀倒置的加上自定义的包名，采用小写字母。
在部门内部应该规划好包名的范围，防止产生冲突。
部门内部产品使用部门的名称加上模块名称。
产品线的产品使用产品的名称加上模块的名称。
格式：com.huawei.产品名.模块名称com.huawei.部门名称. 项目名称示例：Relay模块包名 com.huawei.msg.relay通用日志模块包名 com.huawei.msg.log2）. 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。
示例：OrderInformation,CustomerList,LogManager,LogConfig3）. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。
示例：private void calculateRate();public void addNewOrder();4）. 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。
格式：get + 非布尔属性名()is + 布尔属性名()set + 属性名()动词()动词 + 宾语()示例：public String getType();public boolean isFinished();public void setVisible(boolean);public void show();public void addKeyListener(Listener);5）.属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。
属性名不能与方法名相同。
示例：private customerName;private orderNumber;private smpSession;6). 常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。
软件开发说明书(ISO标准)
软件开发说明书（ISO标准）1引言（Introduction）1.1编写目的（Purpose）简要说明编写本需求分析说明书的目的。
1.2读者对象（Reader）简要说明本需求分析说明书可能的合法读者对象。
1.3编写原则（Rule）简要说明本需求分析说明书的编写原则。
1.4编写目标(Goal)简要说明本需求分析说明书的编写目标。
1.5项目背景(Background of Project)简要说明关于本项目的项目名称、简称、项目代号、委托单位、开发单位和主管部门、该软件系统与其它系统的关系等背景信息。
1.6定义(Definitions)简要说明本需求分析说明书中涉及的专门术语、容易引起歧义的概念、关键词缩写及其他需要解释的内容。
1.7参考资料（Reference）以列表或排序的方式给出重要的参考资料的名称、作者、单位、出版日期、地点、联系方式等信息。
1.8变更历史(Change History)2任务概述(Task Description)（可以以合同文本为基础阐述清楚如下观点。
）1)本系统开发完成后的用途,能够产生的效果;2) 实现技术先进性、可靠性、易操作性、易维护性、易扩展性和安全性；3) 如果分多期工程，应按工期分别列出其目标。
3业务需求调查(Business Processes and Flows)3.1组织机构调查此处给出组织关系结构图以及组织、部门、岗位的隶属关系与职能。
3.2应用现状调查1)现有计算机系统的网络、服务器、终端的软硬件环境、状态、数量、关系2)现行应用系统的分布及运行状况3)客户对现有应用系统优缺点的评价4)现有应用系统的数据来源和出口（IPO）3.3业务处理总体流程调查3.3.1总体流程图给出总体业务流程图。
1)描述组成系统的各个子系统(或环节)之间的业务处理关系。
2)列出分析的基本原则。
3)严格按照图表的含义设计流程图，主要图标所表达的意义见另文。
（包括文字和流程图），注意，这里所说的环节必须具有通用性。
软件开发编码要求规范说明书
2017软件开发编码规范说明梁峰2017-5-31一、高级语言 (2)1.1适用围 (2)1.2程序风格 (2)1.2.1.代码缩进 (2)1.2.2.变量申明 (2)1.2.3.代码块长度 (2)1.2.4.代码换行 (2)1.2.5.空行及空格 (3)1.3命名 (3)1.3.1.变量命名 (3)1.3.2.常量命名 (4)1.3.3.函数或方法命名 (4)1.3.4.文件命名 (4)1.4注释 (4)1.4.1.代码注释 (4)1.4.2.变量注释 (5)1.4.3.函数注释 (5)1.4.4.文件注释 (5)1.5错误和异常处理 (6)1.5.1.错误处理 (6)1.5.2.异常处理 (6)1.6注意事项 (8)1.6.1.变量的使用 (8)1.6.2.代码实现 (9)1.7日志规约 (9)二、结构化查询语言 (11)2.1.程序风格 (11)2.1.1.SQL语句 (11)2.1.2.存储过程 (13)2.1.3.存储过程命名 (13)2.1.4.变量命名 (13)2.1.5.游标命名 (13)2.1.6.常量命名 (13)2.2.建表规约 (13)2.1.安全规约 (15)2.3.注释 (16)2.3.1.代码注释 (16)2.3.2.存储过程注释 (16)2.3.3.常量及变量注释 (17)2.4.错误和和异常处理 (17)2.5.注意事项 (17)一、高级语言1.1适用围主要针对JSP，CSS和JAVA高级编程语言，其它高级语言可参照执行。
1.2程序风格1.2.1.代码缩进程序块（包括函数、过程、结构的定义及循环、判断等语句）要严格采用缩进风格编写，对齐只使用空格键，不使用TAB键，所有的缩进为4个空格。
1.2.2.变量申明在函数部申明变量时，必须在函数的开始位置。
1.2.3.代码块长度单个函数的程序行数不得超过200行。
一个程序文件的长度不得超过5000行代码。
1.2.4.代码换行1.较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
软件开发编码规范
软件开发编码规范
1. 前言
编码规范是一些制定约束和规范的方法。
在软件开发中，遵循编码规范可以帮
助开发者更轻松地开发出高效、高质量、易于维护和高性能的软件。
随着项目规模的增大和团队的扩大，软件代码不遵循规范所带来的问题也越来
越明显，为了便于团队协作，提高代码可维护性和可重用性，本文将详细介绍软件开发编码规范。
2. 命名规范
2.1 文件名
文件名应该简洁而具有描述性，使用推荐的文件命名规范。
文件名应全部小写，并使用连字符“-”分隔单词。
例如:
•my-awesome-file.js
•index.html
•my-awesome-file.css
2.2 变量名
变量名应该清晰、简洁和有描述性。
变量名应该遵循一定的命名规范，如下：•变量名应全部小写，并使用下划线“_”分隔单词。
•变量名应该具有描述性，且应该以其类型作为前缀，例如 strName、nCount 等。
•避免使用大小写区分变量类型的命名方式，如 intCount、sMessage 等。
例如：
int age;
string name;
float price_per_unit;
2.3 常量名
常量名要求全部大写，并使用下划线“_”分隔单词。
例如：
``` const int MAX_SIZE = 100; const char *MESSAGE =。
ISO9001-软件工程开发标准文档模板 计算机软件开发文档编写指南
一、项目开发计划1．引言 (1)1.1编写目的 (1)1.2项目背景 (1)1.3定义 (2)1.4参考资料 (2)2．项目概述 (2)2.1工作内容 (2)2.2条件与限制 (2)2.3产品 (2)2.4运行环境 (2)2.5服务 (3)2.6验收标准 (3)3．实施计划 (3)3.1任务分解 (3)3.2进度 (3)3.3预算 (3)3.4关键问题 (3)4．人员组织及分工 (3)5．交付期限 (3)6．专题计划要点 (3)1．引言1.1编写目的【阐明编写开发计划的目的，指明读者对象。
】1.2项目背景【可包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。
】1.3定义【列出本档中用到的专门术语的定义和缩写词的原文。
】1.4参考资料【可包括：a.项目经核准的计划任务书、合同或上级机关的批文；b.文档所引用的资料、规范等；列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。
】2．项目概述2.1工作内容【简要说明项目的各项主要工作，介绍所开发软件的功能、性能等。
若不编写可行性研究报告，则应在本节给出较详细的介绍。
】2.2条件与限制【阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。
必要时还应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制。
】2.3产品2.3.1程序【列出应交付的程序名称、使用的语言及存储形式。
】2.3.2文档【列出应交付的文档。
】2.4运行环境【应包括硬件环境、软件环境。
】2.5服务【阐明开发单位可向用户提供的服务。
如人员培训、安装、保修、维护和其他运行支持。
】2.6验收标准3．实施计划3.1任务分解【任务的划分及各项任务的负责人。
】3.2进度【按阶段完成的项目，用图表说明开始时间、完成时间。
】3.3预算3.4关键问题【说明可能影响项目的关键问题，如设备条件、技术焦点或其他风险因素，并说明对策。
】4．人员组织及分工5．交付期限6．专题计划要点【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。
ISO文件编写与编号导则
文件号：RF -G办-001 页码：第1页共5页1.0 目的和范围：本导则是为公司属下各个职能部门开展文件编写工作而制定的，目的是使公司内文件的编写与编号规范化、标准化和统一化。
本导则适用于公司内所有文件的编写与编号。
2.0 职责：2.1 行政部负责编制本导则。
2.2 行政部负责编写质量手册。
2.3 各部门指定的人员负责起草本部门的程序文件和工作文件。
2.4 各部门负责人和起草人负责修改、更新本部门的程序文件和工作文件。
2.5 文件的格式应与本导则一致。
3.0 管理内容：3.1 文件的格式3.1.1 刊头部份采用统一的格式（见附录A，附录B）3.1.2 质量手册正文中各条款描述的格式：（1）标准条款的编号；（2）标准条款的描述内容；（3）有关工作程序。
3.1.3 程序文件正文格式：（1）目的；（2）适用范围；（3）职责；（4）工作程序；（5）相关文件；（6）记录和报告。
3.1.4 工作文件正文格式：（1）目的；（2）范围；（3）职责；（4）管理内容；（5）记录和报告；文件号：RF -G办-001 页码：第2页共5页3.2 文件的内容：3.2.1 刊头刊头部份应包括下列内容：（1）标题：文件名称；（2）文件号；按统一规定的编号办法（见本导则3.7）；（3）版本号：以A、B、C．．．．．．表示，例如手册换版，手册的版本号由“A”改为“B”；（4）修改号：以0、1、2．．．．．．表示，例如需改手册的某章节内容，修改后的相应的修改标识由“0”改“1”；（5）页码号：标明页序和累积页数。
3.2.2 质量手册的内容质量手册主要包括以下内容：（1）名称、范围和适用领域；（2）目录；（3）本公司的简介；（4）质量手册的颁布令；（5）本公司的质量方针和目标；（6）组织机构、职责和权限；（7）质量管理体系要求各条款的描述和程序文件的引用；（8）引用标准和术语（定义）；（9）质量手册管理办法。
3.2.3 程序文件正文部分包括以下的内容和要求：（1）目的：为什么要开展此项活动；（2）适用范围：文件适用（或不适用）于哪些范围（含部门、活动、人员和产品）；（3）职责：指负责实施该文件的部门或人员的职责、权限及相互关系；（4）工作程序：依序阐述开展职能活动的内容和方法；（5）相关文件：明确文件涉及的相关程序、工作文件等；（6）记录与报告：明确文件使用记录或报告。
iso编号规范iso编号规范.doc
iso编号规范_iso编号规范iso编号规范1 目的确保公司重要文件具有唯一编号，便于文件的识别、追溯和控制，保证公司文件体系有效运转。
2 使用范围适用于公司文件的编号管理和控制:a) 技术类文件:是指在公司的设计、生产、销售、服务等各个环节中与技术有关的各类文件和资料。
b) 其他文件:包括公司规章制度、管理文件、合同协议、传真等;c) 编号文件包括纸介文件以及电子文件。
3 编号办法3.1 公司名称及项目名称约定:公司全称为:南非中国制衣集团(北京)本组织简称:CGMBJ项目全称:CGM 企业信息管理系统 1.0版项目简称:CGM v13.2 日期表示格式:yyyy-mm-dd 或 yyyymmddyyyy:用四位数字表示公元年份，如2005表示公元2005年。
mm:用两位数字表示月份，不足两位时，第一位用零补齐，如03表示3月。
dd: 用两位数字表示日期，不足两位时，第一位用零补齐，如15表示第15号。
例如:2003-10-27 或 20031027 表示(2003年10月27日) 3.3 文件版本编号下面是对文件版本进行编号要遵守的标准:起草版本的编号为 0.1, 0.2, 0.3, ..., 0.10。
版本编号可以根据项目需要延伸到若干层，例如， 0.1, 0.1.1, 0.1.1.1.一旦文件版本得以确认后，版本编号应该始自 1.0。
版本编号不断变化为: 1.0, 1.1, 1.2, ..., 1.10。
项目可以根据需要将版本编号晋升为2.0，2.1, 2.2 等。
3.4 技术文件命名格式:CGM-vnn-(AA-)BB-yyCGM:项目缩写。
nn:版本号，参见3.3节。
AA:子项目名称。
yy:文件版本号。
BB:工作过程名称:相应工作过程名称的简称(例如 SPP，SRS)不是必需的，但如果要使用，应该遵守下面表格中的标准。
验收测试计划 (Acceptance Test Plan) ATP验收测试报告 (Acceptance Test Report) ATR检查单 (Check List) CL程序修改报告 (Code Difference Report) CDR软件构成设计文件 (Software Component Design Document) CDD具体设计文件 (Detail Design Document) DDD软件功能设计文件 (Software Function Design Document) FDD 软件功能说明书 (Software Function Specification) FS手册 (Hand Book) HB系统集成测试计划 (System Integration Test Plan) ITestPlan 系统集成测试报告 (System Integration Test Report) ITestRep 组间协作文件 (Intergroup Coordination Document) ICD初步设计文件 (Preliminary Design Document) PDD软件配置管理文件 (Software Configuration Management SCM Plan Document)软件开发策划文件 (Software Development Plan Document) SDP 软件项目策划文件 (Software Project Plan Document) SPP软件质量保证计划 (Software Quality Assurance Plan) SQA软件需求规格说明 (Software Requirements Specification) SRS 工作说明 (Statement of Work) SOW子系统测试计划 (Sub-System Test Plan) SSTP子系统测试报告 (Sub-System Test Report) SSTR子系统测试脚本 (Sub-System Test Script) SSTS软件维护计划 (Sustaining Plan) SP系统操作描述 (System Operations Description) SOD系统测试计划 (System Test Plan) STestPlan系统测试报告 (System Test Report) STestRep培训计划 (Training Plan) TP例如:CGM-v1-需求规格说明书-0.1.docCGM-v1-SRS-1.2.docCGM-v1-信息控制子系统-验收测试计划-2.0.doc3.5 其他文件的编号3.5.1 公司规章制度和管理文件公司规章制度和管理文件的编号格式为:CGMBJ(-DN)-TT.AB-ddDN:大写英文字母，部门代号，如该制度是公司级文件，适用于公司全体人员，该部分编码省略;如该文件是部门内部管理制度，则应标记部门编号，表示该制度由部门内部使用。
软件开发编码规范
软件安全开发编码规范1. 代码编写1) 开发人员应保证工程中不存在无用的资源（如代码、图片文件等）。
2) 代码中每个类名上的注释必须留下创建者和修改者的名字。
3) 每个需要import的类都应使用一行import声明，不得使用import xxx.*。
4) System.out.println()仅在调试时使用，正式代码里不应出现。
5) 开发人员编写代码时应遵循以下命名规则：●Package 名称应该都是由一组小写字母组成；●Class 名称中的每个单词的首字母必须大写；●Static Final 变量的名称全用大写，并且名称后加注释；●参数的名称必须和变量的命名规范一致；●使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名称。
6) 代码应该用unix的格式，而不是windows的。
7) exit 除了在main 中可以被调用外，其他的地方不应被调用。
8) 代码中应尽量使用interfaces，不要使用abstract类。
9) 在需要换行的情况下，尽量使用println 来代替在字符串中使用的"\n"。
10) 涉及HTML的文档，尽量使用XHTML1.0 transitional文件类型，其中所有HTML标签都应关闭。
11) 在HTML、JavaScript、XML代码中，缩进应为两个空格，不得使用Tab。
12) HTML标签的name和id属性的命名方式应与Java变量名相同。
13) 在需要经常创建开销较大的对象时，开发人员应考虑使用对象池。
14) 在进行log的获取时开发人员应尽量使用isXXXEnabled。
15) log的生成环境上尽量避免输出文件名和行号。
16) 产品中不要包含后门代码，隔离系统中的后门代码，确保其不能出现在产品中。
作为一种特殊的调试代码，后门访问代码是为了使开发者和测试工程师访问一部分终端用户不能访问的程序代码。
但是，如果后门代码被留到产品中，对攻击者来说，它就是一条不需要通过正常安全手段来攻陷系统的通路。
06软件开发ISO规范文档详细设计说明书
文档编号：[文档编号][项目名称]详细设计说明书版本号：[版本号]受控编号：[受控编号]编写部门：[编写部门]编写人：[编写人]审核人：[审核人]审核日期：2018年8月19日批准人：[批准人]日期：2018年8月19日目录1．引言 (1)编写目的背景定义参考资料2．程序系统结构 (1)3．元素索引表 (1)4．程序设计 (1)元素名元素名==================请使用本模板者自己补充此目录==================1．引言1.1) 编写目的[在此说明编写这份概要设计说明书的目的，指出预期的读者。
]1.2) 背景[系统名称][项目提出者、开发者、用户、运行地点]1.3) 定义[术语和缩写说明]1.4) 参考资料[本项目的计划任务书或合同、上级机关批文][本项目已发布文档][本文引用的其它文档资料（包括各种开发标准）]2．程序系统结构[用一系统图表列出模块内名元素的名称、标识及相互间的层次结构关系] 3．元素索引表[元素索引（元素名，及其详细说明部分在本文中的起止页码）4．程序设计4.1) [元素名(与索引表中对应)]a) 程序描述[元素的目的/意义/常驻内存/可重入/并发/覆盖要求等等]b) 功能[该元素应具有的功能(可用IPO图)]c) 性能[对元素性能的要求(精度/灵活性/时间特性等)]d) 输入项[每一输入项的特性(名称/标识/类型/取值范围/输入方式/来源/安全等)]e) 输出项[每一输出项的特性(名称/标识/类型/取值范围/输入方式/来源/安全等)]f) 算法[元素使用的算法,具体计算公式及计算步骤]g) 流程逻辑[元素的完整流程图(必须有完整的说明)]h) 接口[用图形方式说明本元素在系统中的定位及赋值/参数/数据等信息i) 存储分配[若有需要,说明元素的存储分配方式]j) 注释设计[元素首部的注释内容][各节点的注释(变量功能/变量范围/缺省条件等)][为所使用的逻辑加的注释内容]k) 限制条件[本元素正常运行所必需的条件(如,必需有某文件)]l) 测试计划[本元素的详细测试计划(人员/环境/标准/反馈机制/评价方式/目标等)m) 尚未解决的问题[元素设计中尚未解决需系统完成前必需解决的问题] 4.2) [元素名(与索引表中对应)]……内容与格式同 4.1……同上，直至所有元素描述完毕。
ISO软件开发全套文档 操作手册_
Software Project Plan操作手册版本 <1.0>修订历史记录目录1.引言41.1编写目的41.2前景41.3定义41.4参考资料42.软件征述42.1软件的结构42.2程序表42.3文卷表43.安装与初始化44.运行说明44.1运行表44.2运行步骤44.3运行1（标识符）说明44.3.1运行控制54.3.2操作信息54.3.3输入一输出文卷54.3.4输出文段54.3.5输出文段的复制54.3.6恢复过程54.4运行2（标识符）说明55.非常规过程56.远程操作5操作手册（GB8567——88）1.引言1.1编写目的说明编写这份操作手册的目的，指出预期的读者。
1.2前景说明：a．这份操作手册所描述的软件系统的名称；b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心。
1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有用的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2.软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。
2.2程序表列出本系统内每个程序的标识符、编号和助记名。
2.3文卷表列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、助记名、存储媒体和存储要求。
3.安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。
如果有的话，还应说明安装过程中所需用到的专用软件。
4.运行说明所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。
ISO文件编码规则
4. 工作程序
4.1 文件的分类和编号
4.1.1 文件分为如下几类:
1)品质管理手册(一级文件)QM
2)程序文件(二级文件)QP
3)作业指导文件(三级文件)WI (设备操作指导、作业指导、检验标准等)
4) 记录表单(四级文件)QR
5) 外来文件ED
4.1.2 文件编号规定如下:
1)品质管理手册的编号
DM / QM –□□□□
文件版本年号(2009)
文件类别号
企业代号
2)程序文件的编号
DM / QP □□
程序编号(流水号如01、02…)
文件类别号
企业代号
3)作业性文件编号
DM / WI - □□- □□□
流水号(流水号如001、002…)
部门代号
文件类别号
企业代号
4)记录是一种特殊性文件,编号如下:
DM / QR - □□ - □□□
流水号(流水号如001、002…)
部门代号
文件类别号
企业代号
5)若外来文件有编号时,依其编号执行;若无时,按下列方式进行编号: DM / ED - □□ - □□□
流水号(流水号如001、002…)
部门代号
文件类别号
企业代号
体系也没规定,公司没要求的话,就爱怎么规定就怎么规定,只要写清楚可以看懂的方法就可以。
软件开发编码规范
软件开发编码规范are Security Development Coding Standards1.Code Writing1) Developers should ensure that there are no unused resources (such as code。
image files。
etc.) in the project.2) Comments on each class name in the code must include the names of the XXX.3) Each class that needs to be imported should have a separate import statement and not use import xxx.*.4) System.out.println() should only be used for XXX.5) Developers should follow the following XXX:Package names should consist of a group of lowercase letters;The first letter of each word in the class name must be capitalized;The names of static final variables should be in uppercase。
with comments added after the name;The parameter names must be consistent with the variable naming n;Use meaningful parameter names and。
if possible。
use the same name as the field to be assigned.6) Code should be formatted in Unix format。
软件开发编码规范
. . . .软件开发编码规(C#) . . . .目录1 引言 (3)1.1 编写目的 (3)1.2 背景 (3)1.3 定义 (3)1.4 参考资料 (3)2 基本要求 (3)2.1 程序结构要求 (3)2.2 可读性要求 (3)2.3 结构化要求 (4)2.4 正确性与容错性要求 (4)2.5 可重用性要求 (5)3 用户界面设计原则 (5)4 源程序书写规 (5)4.1 通用源代码格式规则 (5)4.1.1 缩进 (5)4.1.2 边距 (6)4.1.3 “{}”的使用 (6)4.1.4 注释 (6)4.2 语句格式与语句书写规 (7)4.2.1 括号 (7)4.2.2 保留字和关键字 (7)4.2.3 函数 (7)4.2.4 变量 (7)4.2.5 语句 (8)5 命名规 (9)5.1 函数命名 (9)5.2 形参 (9)5.3 常量和变量 (9)5.3.1 常量和宏定义 (9)5.3.2 变量 (10)5.4 函数使用说明、接口命名、NameSpace命名 (11)5.5 控件的命名 (11)5.6 类型 (12)5.6.1 一般类型 (12)5.6.2 构造类型 (12)5.6.3 类类型 (12)5.7 文件和文件夹 (13)5.7.1 文件夹的命名规则 (13)5.7.2 文件命名 (13)6 源程序文档注释规 (13)6.1 注释文档的一般规 (13)1引言1.1编写目的本规旨在用规文件的形式，对全公司使用C#进行的编程过程，进行有效的规管理，使得最终的软件产品具有良好的风格和统一的结构，且使代码可读性强、易维护。
本规预期读者是全公司所有参与编程的软件开发人员以及其他相关人员。
本标准适用于Visual C# ,其余语言作参考。
1.2背景公司在上一个项目中由于代码编写风格不统一，可读性较差、较难维护，使得工作效率有所降低。
1.3定义无1.4参考资料Pascal Standards FAQ (E)JavaDoc （E）Doc-O-matic Document (E)Artemis Alliance Delphi Coding Standards (E)《C#基本书写规》《C#编码规纲要》2基本要求2.1程序结构要求程序结构清晰，简单易懂，单个函数的程序行数一般不得超过100行,个别特殊函数除外。
软件开发规范：编码规范
软件开发规范：编码规范C#编码规范目标：1. 安全：代码完成所需的功能之余,不要产生负作用，即要稳定可靠。
2. 易读: 类、实例、成员变量、成员函数的命名一目了然3. 美观: 尽量统一项目组内人员的编程风格。
第一部分：命名1. 命名原则1) 所有的函数（变量/类/文件名）应该代表其实际的作用，应该使用有意义的单词或多个词组合，但不要使用人名、项目组名。
2) 所有的函数（变量/类名）一律使用英文。
3) 使用多个单词时不需要使用连线(如下划线), 但对于全部大写的宏需要使用连线。
4) 多个词组合较长时, 可以使用单词的缩写。
5) 不得使用非常相近的名字类表示几个不同含义的函数（变量/类）。
6) 命名时请考虑名字的唯一性和含义的准确性。
7) 使用项目组专用词汇来表达特定的含义(概念), 不得把专用词汇挪作他用。
2. 变量的命名原则: 使用匈牙利命名法命名变量1) 变量名一般由“类型修饰＋代表变量含意的英文单词或单词缩写”等部分组成。
类型修饰(小写字母)：n: int，l: LONG/long， s: short，u: UINT，f: floatb: bool，by: BYTE，ch: char， sz: char[],str: string2) 针对异常捕获过程中的 Exception 变量命名，在没有冲突的情况下，统一命名为e；如果有冲突的情况下，可以重复 e，比如：ee。
3. 函数的命名1) 使用动宾词组表达函数实际所作的事。
2) 同名的函数(重载函数)在功能上应该完全相同, 在参数上的差别也应一目了然。
3) 不得出现名字非常相近但功能不同的函数. 如 CreatePage1(), CreatePage2()等。
4. 类命名1) 名字应该能够标识事物的特性。
2) 名字尽量不使用缩写，除非它是众所周知的。
3) 名字可以有两个或三个单词组成，但通常不应多于三个。
4) 在名字中，所有单词第一个字母大写，缩写都要大写。
文件制作编码作业指导书ISO
1．目的：为落实文件管理，使文件编制、编码管理时，有遵循的依据。
2．适用范围：适用于本公司范围内与质量管理体系运行有关的所有文件。
3．定义3.1机密级文件资料文件泄漏后，足以危害到客户、公司、供方的利益，或对公司之营运及声誉有重大、深远影响的文件资料，(如客户提供之技术资料、产品开发与技术研究资料、知识产权、营业秘密及限制特定承办人员办理之特殊文件资料等，由公司特派人员进行管理)。
3.2一般级文件除机密级以外，其它的文件资料均属之4．职责4．1制作人员：按实际作业制订/修订变更文件内容及版次。
4．2各部门主管：文件之审核、会签、批准4．3 品管部对质量管理文件进行统一编码，并盖章发行存档。
5．作业说明5.1文件制作5.1.1各部门实际作业需增文件时，应按文件模版形式自行编写文件草案，呈部门主管核准。
若有意见应于部门内协调，并自行修正草案。
5.1.2新制作质量环境系统文件(包括表单)由制作部门拟定草稿，经部门主管审查后，填写文件制订/修订申请单，a)在申请单“制订即首次发行”前“□”内打“√”表示是新制订的文件，b)按《文件和资料控制程序》内规定的文件类别，在相应的文件类别前“□”内打“√”c)将“文件名称、制订版本、总页数、申请部门、申请人”信息填好，申请编号由文控中心统一提供。
d)明确写明“申请原因”，并将制订内容大致题纲填写在“制订/变更内容”栏空白处。
c)决定需会签部门，填写会签部门并在需会签主管栏空白内打“√”，或明确拟定会签主管。
e)提交部门主管签字确认。
5.1.3系统文件草案(包括表单)完成后，由制作部门向品质部文控中心申请文件编号。
5.1.4若系统文件为修订文件，应与文控中心核对版次；并将最新版本填写在文件制订/修订申请单内，a)在申请单“修订”前“□”内打“√”表示是文件需进行修订，b)按《文件和资料控制程序》内规定的文件类别，在相应的文件类别前“□”内打“√”c)将“文件名称、与文控中心核对版本、总页数、申请部门、申请人”信息填好。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
最新编辑《项目编码规范》的编写应根据《程序编写规范模板》，并基于项目的特征以及客户的要求，生成本项目的《项目编码规范》。
《项目编码规范》不可违反《程序编写规范模板》。
其内容如下：
项目编码规范
1 命名规范
根据《程序编写规范模板》中的“1 命名规范”进行编写，并采用与本系统所采用的开发平台对应的《程序编写规范模板》附录所描述的前缀选取办法。
2 程序注释规范
根据《程序编写规范模板》中的“2 程序注释规范”进行编写。
项目经理或其指定的人员可根据项目的具体情况进行进一步的要求，并说明原因。
例如国外项目需要用英文注释等。
3 程序代码书写规范
根据《程序编写规范模板》中的“3 程序代码书写规范”进行编写。
项目经理或其指定的人员可根据项目的具体情况进行进一步的要求，并说明原因。
例如客户的某一特殊要求等。