项目开发及编码规范

项目开发规范文档修订历史记录

1.简介

1.1目的

1、用于规范指导开发组进行开发

2、便于成员间的沟通与交流。

3、有助于项目质量和稳定。

4、为后期维护提供支持

2. 项目开发流程

项目开发过程归纳分为以下步骤：

1. 建立SVN项目版本控制。包括文档，源码，Lib包等。

2. 了解需求，并对需求文档的书写。(见文档结构规则附录)。

3. 详细设计文档。(见文档结构规则附录)。

3.1 功能模块设计，重要模块的算法设计。

3.2 数据库设计等。

3.3 根据需求定义开发平台及环境。

4. 编码。

4.1 搭建开发平台，配置开发环境。

4.1 编码。

4.2 单元测试案例。

5. 书写软件安装手册文件，数据库脚本文件，以及注意事项(release notes)。

6. 交互测试组测试。根据测试组测试结果是否回归第4步（测试回归最好不要超过2

次）。

7. 测试通过，交付上线使用。

7.1 维护手册

7.2 使用手册

3. 代码规范

3.1 Java 代码规范

3.1.1 Java类名

类名可由：英文字母，数字，下划线组成。（数字，下划线不能够开头）

类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。

类名要求首字母大写，多个单词组成类名时，单词的首字母要求大写。

建议：类名不要过于简单或者太长。可以对单词采用简化的名称：入：Number 简化为：num 。

3.1.2 Java类结构

类仅作为数据结构，没有行为，他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一，或者功能类似共有行为的。一个类不要过于庞大。

通常情况下：

一般逻辑类中应该有构造方法和main方法，main方法中应该有测试代码。

每个类应该有toString() 方法。

3.1.2.1 包和引入语句

在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。

报名的定义全部是小写字母。具体定义依据项目而定。

引入包时候，同一类型的归纳到一块，用空行隔开。例如：

import java.util.ArrayList;

import java.util.List;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import com.ericsson.omc.persistence.etl.ImsEtlTaskDao;

import com.ericsson.omc.persistence.mapping.nemsg.Counter;

import com.ericsson.omc.persistence.mapping.nemsg.EtlTask;

import com.ericsson.omc.persistence.mapping.nemsg.Indicator;

import com.ericsson.omc.persistence.mapping.nemsg.Node;

3.1.2.2 类注释

Java类开头应该有相应的注释：类版本描述，作者签名，日期时间，公司备注，类的功能作用相关描述等。（详细查看：注释）

3.1.2.2 类成员变量

a) 类变量要求放在类的开始声明。一行声明一个。

b) 变量名称首字母要求小写。其他命名规则类似与类名。

c) static , final 类型的变量，字母要求全部大写。

d) 尽量在声明局部变量的同时初始化。

e) 避免局部变量和成员变量同名，覆盖了成员变量。

f) 尽量变量私有化，缩小变量的作用域。

3.1.2.3 类成员方法

a) 方法名命名规则类似于成员变量命名规则。

b) 成员方法尽量私有化。

d) 方法与方法之间空一行分割，提高可读性。

c) 方法尽可能有注释：（详细查看：注释）

e) 方法尽可能尽早返回，结束。

3.1.3 Java语句

3.1.3.1 缩进排版

a) 4个空格(一个Tab建)常被作为缩进排版的一个单位。子模块应该和父模块保持一个缩

进单位。

b) 尽量避免一行的长度超过80个字符.

c) 换行：

当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：

- 在一个逗号后面断开

- 在一个操作符前面断开

- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开

- 新的一行应该与上一行同一级别表达式的开头处对齐

- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。如：

someMethod(longExpression1, longExpression2, longExpression3,

longExpression4, longExpression5);

var = someMethod1(longExpression1,

someMethod2(longExpression2,

longExpression3));

3.1.3.2 注释

Java程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/*...*/和//界定的注释。文档注释(被称为"doc comments")是Java 独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。

实现注释用以描述实现的细节，流程，和难点的描述。良好的实现注释有助于自己和别

人易于读懂代码。文档注释它可以被那些手头没有源码的开发人员了解接口功能等。

频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下是否可以重新设计该模块的代码结构或者逻辑，使其更清晰，而避免使用注释提醒该模块的实现，这样往往都能够提高代码质量。

注释应被用来给出代码的总括，良好的代码里应该有大量的注释。当然也要避免代码已经提供清晰明了，显而易见注释。

注释的格式：

程序可以有4种实现注释的风格：块、单行、尾端和行末。

分别由：

/** notice */ 块

/* notice */ 单行

/* notice */ 尾端

// 行末

注释要求：

●无论是用户端表示层程序还是组件程序，注释必不可少。

●要求能占程序总量的10%以上。

●注释必须在程序改变时实时更新。

●简单明了，确保任何程序员都可以读懂。

●注释一般应写在代码之前，并与代码分开不同的行；但对于说明变量含义的注释，

一般应写在变量说明的同行的行末，并且在各行间保持对齐；

●如果可能，尽量使用单行注释‘//’。

●对于代码维护，应在过程或方法中记录相应修改的作者、时间，并在具体修改的位

置用特殊的标签注明（标签一般应包含修改人的名字汉语拼音或拼音简写、日期戳

和可选的修改项目名字）。例子如下：

一．实现注释：

实现注释应该在构建内部必要的过程中加上必要的注释，包括：功能描述、参数说明、返回值说明、最后更新作者(如果有改动)、最后更新日期(如果有改动)。重要变量应该在行末使用”//”加上注释。重要的，难点流程，应该加上行注释，或者尾端，行末注释。

二．JavaDoc注释：

为规范、方便生成统一的程序文档，应在代码注释中遵循JavaDoc的注释规范（在Eclipse 中输入“/**回车”，会自动根据你的java方法参数，返回类型等填入注释项。）

3.1.3.3 语句示例：

a) 简单语句

每行至多包含一条语句，例如：

argv++; // Correct

argc--; // Correct

argv++; argc--; // A VOID!

b) 复杂语句

复合语句是包含在大括号中的语句序列，形如"{ 语句}"。例如下面各段。

- 被括其中的语句应该较之复合语句缩进一个层次

- 左大括号"{"应位于复合语句起始行的行尾；右大括号"}"应另起一行并与复合语

句首行对齐。

- 大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如if-else或for

控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug。

c) for 语句

for语句中，避免吧运算表达式写入for中

例如：

Object[] array = new Object[1000];

for( int i = 0; i < array.length; i++){

// do somethine

}

此时在for循环中将会重复计数array的长度，优化后应该是：

Object[] array = new Object[1000];

Int len = array.length;

for( int i = 0; i < len; i++){

// do somethine

}

d) try – catch 语句

一个try-catch语句应该具有如下格式：

try {

statements;

} catch (ExceptionClass e) {

statements;

}

一个try-catch语句后面也可能跟着一个finally语句，不论try代码块是否顺利执行

完，它都会被执行。

try {

statements;

} catch (ExceptionClass e) {

statements;

} finally {

statements;

}

对一些数据库的连接，io访问等，尽量使用finally{ }块，在finally块中关闭开启的资源。

e) return 语句

如：

if (booleanExpression) {

return true;

} else {

return false;

}

应该改为下面方式更加简洁：

if (booleanExpression) {

return true;

}

return false;

f) ：if(!(block_id < actblks) || !( block_id >= unblks))，

不如写成if((block_id >= actblks) || (block_id < unblks))

多加上括号，增加易读性，也排除二义性：

if( block_id >= actblks || block_id < unblks )

比如写成：if( (block_id >= actblks) || (block_id < unblks) )

g) 空行，空格

空行：

空行将逻辑相关的代码段分隔开，以提高可读性。

下列情况应该总是使用两个空行：

- 一个源文件的两个片段(section)之间

- 类声明和接口声明之间

下列情况应该总是使用一个空行：

- 两个方法之间

- 方法内的局部变量和方法的第一条语句之间

- 块注释之前

- 一个方法内的两个逻辑段之间，用以提高可读性

空格：

下列情况应该使用空格：

- 一个紧跟着括号的关键字应该被空格分开，例如：

while (true) {

...

}

注意：空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。

- 空白应该位于参数列表中逗号的后面

- 所有的二元运算符，除了"."，应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格，比如：负号("-")、自增("++")和自减("--")。例如：

a += c + d;

a = (a + b) / (c * d);

while (d++ = s++) {

n++;

}

printSize("size is " + foo + "\n");

- for语句中的表达式应该被空格分开，例如：

for (expr1; expr2; expr3)

- 强制转型后应该跟一个空格，例如：

myMethod((byte) aNum, (Object) x);

myMethod((int) (cp + 5), ((int) (i + 3)) + 1);

3.2 Jsp，JavaScript 代码规范

3.2.1 Jsp文件

Jsp文件命名，首字母要求小写，名称可以用多个单词组成。每个单词组合时候首字母大写。

建议：

列表页面为：XXXList.jps

表单展示页面为：XXXView.jsp

表单修改页面为：XXXModify.jsp

Jsp文件的内容编码格式和文件本身的编码格式要求统一。具体视项目要求。

页面尽量使用同一种标签表达，比如只使用struts标签，或者JSTL标签。

3.2.2 JavaScript文件

JavaScript脚本尽量建立独立的以”js”为后缀的独立文本文件。页面单独应用js文件即可。文件命名与jsp文件相同。文件本身的编码格式需要和整个项目文件编码一致。

一个js文件包含一个或者多个function函数。

3.3数据库对象定义规范

3.3.1表名命名规则

?数据库表的命名以是名词的复数形式且都为大写，如ACCOUNT，INDICA TOR_HISTORY等等

?如果表名由几个单词组成，则单词间用下划线("_")分割，如

CURRENT_COUNTER等

?表名尽量用全名

?表名限制在30个字符内。当表的全名超过30字符时，可用缩写来减少表名的长度，如description --> desc；information --> info；address --> addr等（oracle限制表名超过30个字符）

3.3.2表字段名命名规则

?字段名为小写

?字段名为有意义的单词，或单词的缩写

?如果字段由几个单词组成，则单词间用下划线("_")分割，如client_id，post_code等?字段名限制在30个字符内。当字段名超过30字符时，可用缩写来减少字段名的长度，如description --> desc；information --> info；address --> addr等

3.3.3 索引命名规则

?索引须按照IDX_table__,其中

是建立索引的表名，是建立索引的字段名

?索引名限制在30个字符内。当索引名超过30字符时，可用缩写来减少索引名的长度，如description --> desc；information --> info；address --> addr等

3.3.4主建、外键命名规则

?主键按照PK_

的规则命名，其中

为数据库表名

?唯一键按照UK_

_的规则命名，其中

为数据块表名，为字段名

?外键按照FK___的规则命名，其中为父表名，为子表名，为序列号

3.4 Java命名规则

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。

4. 开发平台及工具。

4.1平台项目定义

具体开发平台和工具视不同的项目需求而定。同一项目组的开发平台要求尽量统一。

对应J2EE开发平台定义如下列表：

4.1版本控制工具

在没有特殊要求外，要求使用TortoiseSVN 工具。

TortoiseSVN 是Subversion 版本控制系统的一个免费开源客户端，可以超越时间的管

理文件和目录。文件保存在中央版本库，除了能记住文件和目录的每次修改以外，版本库非常像普通的文件服务器。你可以将文件恢复到过去的版本，并且可以通过检查历史知道数据做了哪些修改，谁做的修改。

4.1.1 SVN使用方式：

一：一是简单使用，即建立一个主干项目目录，各个开发成员同时使用这个主干目录进行直接修改与更新。

二：二是建立项目主干，和各个开发成员的分支目录。

(1). 各开发成员建立自己的分支，并在此分支上开发；

(1). 各开发成员把分支合并到主干上并形成较为稳定的版本；

(1). 各个成员重新从主干上建立新的分支，在此分支上开发(即回到第一步)

(1). 循环往复，直到工程结束。

目前使用是的一种方式。

4.1.1 SVN文件提交规则：

项目开发过程中，文件及代码提交规则：

a)有变更代码及文档时候，当天离开公司前要求提交到SVN。

b)提交代码时候，要求代码能够编译通过。

c)提交代的码不能够影响这个项目的启动及运行。尽量避免本次的代码提交而影响到

其他开发人员的工作或者功能模块的运转。

d)若需要更改别人的代码时候，先Update，然后更改，然后commit ；在commit时

候，尽量先Update动作，避免冲突。

5. 文档结构规则附录。

5.1项目需求文档模板结构

0. 文档版本历史标记。

1 引言

1.1 立项背景

1.2 立项原因概述

1.3 文档依据

2. 项目概述

2.1面向的用户人群

2.2实现目标

2.3 项目的图示结构。项目的总体结构图。

2.4项目开发要求

2.5 开发工具

2.6 词汇表，定义相关的词汇，缩略语。

3 功能模块1需求描述

3.1 文字需求描述、

3.2 试图功能模块描述。

4 功能模块2需求描述

4.1 文字需求描述、

4.2 试图功能模块描述。

。。。。

5.1项目设计文档模板结构

0. 文档版本历史标记。

1 简介

1.1 目的

1.2 范围

1.3 系统开发环境

1.4 系统运行环境

1.5词汇表，定义相关的词汇，缩略语。

1.6 相关参考资料。

2. 系统结构

2.1 文字描述系统结构。

2.2 图示系统结构。

3. 功能模块1详细设计

3.1 模块描述

3.2 模块功能描述

3.3 功能结构试图

3.4 参考界面

3.5 信息模型设计

数据字典

3.6 设计方法（算法）

3.7 逻辑流程

3.8 输入输出

3.9 接口

对内接口

对外接口

3.10 限制条件

3.11 测试计划

4. 功能模块2详细设计

4.1 模块描述

4.2 模块功能描述

4.3 功能结构试图

4.4 参考界面

4.5 信息模型设计

数据字典

4.5 输入输出

4.6 设计方法（算法）

4.7 逻辑流程

4.9 接口

对内接口

对外接口

4.10 限制条件

4.11 测试计划。。。。

工程设计图纸编号规定

1 目的为统一设计各阶段、各专业设计输出文件标识，防止设计、施工、安装过程中混淆和误用设计文件。 2 适用范围适用于工程项目的各设计阶段，包括： a) 工程设计，包括可行性研究报告、初步设计、施工图设计； b) 通用设计； c) 非标设备设计。 3 相关文件 MDS-03-2010《工程设计设备编号规定》 MDS-04-2010《设备设计图纸编号规定》 MDS-05-2010《设计图标使用规定》 4 职责设计部负责工程设计图纸编号的确定和修改（需要时）。具体工作为： a) 工程名称、工程代号的确定； b) 子项名称、子项代号的确定和修改（需要时）； c) 图纸编号的确定和修改（需要时）。各设计所负责对工程计图纸编号的正确使用。 5 程序 5.1 设计文件标识管理 5.2 工程项目设计图纸编号 5.2.1 可行性研究图纸编号 K×××— ××— ×× 工程代号 — 专业代号设计阶段代号— 图纸序号图纸序号由工程总设计师按可行性研究报告各专业的先后顺序排列。 5.2.2 初步设计图纸编号 a) 当某些专业图纸分子项时，其图纸编号为： K×××— ×××— ××— ×× 工程代号 — 子项代号— 专业代号设计阶段代号 — 图纸序号 b) 当某些专业图纸不分子项时，其图纸编号为： K×××— ××— ×× 工程代号 — 专业代号设计阶段代号— 图纸序号 c) 图纸序号由各专业负责人按子项、按顺序排列。 5.2.3 施工图设计图纸编号（非标准件图纸编号见5. 6.2） K×××— ×××— ××— ×× 工程代号 — 子项代号— 专业代号设计阶段代号 — 图纸序号 5.2.4 图纸序号图纸序号由各设计人按图纸顺序排列（服从国家规定的常规顺序或施工顺序），取二位数，从01开始。 5.3 工程代号、设计阶段代号和专业代号 5.3.1 工程类别和代号 5.3.1.1 工程类别工程类别分为国内工程和国外工程。国内工程符号以“K”表示，“K”为“凯盛”的“凯”第一个拼音大写字母。国外工程符号以“KF”表示。 5.3.1.2 工程代号

软件项目开发计划规范

软件项目开发计划规范 1 引言 1.1编写目的 ? 阐明开发本软件的目的； ? 说明编写这份项目开发计划的目的； ? 指明软件需求说明书所预期的读者。 1.2背景 ? 表示待开发的软件系统的名称、代码； ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； ? C.说明该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 项目概述 2.1 工作内容简要地说明在本项目的开发中须进行的各项主要工作。 2.2主要参加人员扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。 2.3产品 2.3.1程序列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。 2.3.2文件列出需移交给用户的每种文件的名称及内容要点。 2.3.3服务列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持的级别和服务的期限。 2.3.4非移交的产品说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。 2.4验收标准对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。 2.5完成项目的员迟用限 2.6本计划的批准者和批准日期 3实施计划 3.1工作任务的分门与人员分工

项目编码规范

项目代码编程规范 1.应用范围本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。类应该用来将相关的方法组织在一起。当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法

项目开发计划全解

开发计划 20101115 汪永峰锡市凯旋电机有限公司项目名称: 艾默生用电机准: 期: 2010年11月15日号: 制:

项目开发计划艾默生电机设计开发 1/5 编号：20101115 1 任务来源新产品设计建议书 0KX/QR0705-02-20101115 2目标 2010年10月1日前完成电机10台的制造，所试制的电动机规格为: 供电动机的技术要求，或参考客户提供样品电机测试数据并与之基本一致。 3 项目内容及要求 3.1根据顾客样机，对样机进行检测并岀具检测报告。根据顾客提供电动机的性能要求进行电机的设计，应与样品电机的性能基本一致。工作流程 3.2 电动机的外观与样品一致，机械寿命达 10000次以上。 3.3 电机耐压性能：2000 V/mi n. 3.4 电动机的安全性能应符合相关国家的法律法规及标准。 3.5 在2011年1月20日前完成电机样机 10台的制造，于 1月份交付上海艾默生公司检测试用。 220V AC ，电磁设计数据根据顾客提

项目开发计划艾默生电机设计开发 2/5 编号: 5组织机构项目组成员：徐磊（组长）、汪永峰（副组长）、金菊凤（副组长）、吴传渠、邵海林、顾文峰、沈阳、冯菲丽。职责和权限收集主机相关技术资料（包括技术条件、使用说明书等）； a ）负责工艺文件的制定及标准化工作; b ）采用新工艺的跟踪实施; C ）对时间及工艺准确性负责。工夹模具：唐东杰、顾文峰 a ）负责公司内相关工夹模具的设计、制造工作，并对其设计、制造质量负责; b ）相关零部件的制造工作。质量检验：沈阳负责项目实施过程中的质量检验工作。 a ）负责所有零部件、外协件的加工制造; 6.7 外购外协、生产试制：金菊凤 6.1 项目组长：徐磊 a) 负责项目策划、组织、控制和协调工作; 6.2 6.3 b) C ） d) 审批项目计划及日程安排计划; 负责其他相关文件的审批工作; 负责项目工作进度的检查考核及奖惩工作。项目副组长：汪永峰、金菊凤 a) b) C) d) e) f) 编制质量计划; 编制详细的进度计划，对时间进度负责; 技术方案的制定及审定工作; 各种相关文件的审核工作; 召开必要的技术会议; 样品电机的制造; 项目主设计：吴传渠 a) 6.4 b) C) d) e) f) 负责项目全套技术文件、工艺文件的制定; 跟踪实施样品电机的制造; 提供详细进展报告及例外事件报告; 对技术文件的硬错误负责; 负责样品电机的验证工作并形成文件。工艺及标准化：邵海林、冯菲丽 6.5 6.6

软件项目代码编码规范

变更履历

目录 1总则 (4) 2源代码完整性保障 (4) 3源代码的授权访问 (4) 4代码版本管理 (5) 4.1系统初验 (6) 4.2试运行 (6) 4.3系统终验 (7) 4.4系统验收标准 (7)

1总则 1、为保障公司源代码和开发文档安全不至于泄露，保证源代码的完整，明确源代码控制管理流程，特制定此管理办法。 2、本办法适用于所有涉及接触源代码的各部门各岗位。所涉及部门都必须严格执行本管理办法。 3、源代码直接控制管理部门为技术开发部。 4、本办法管理重点在于控制管理源代码的完整性，不被非授权获取，不被非授权复制和传播。 5、本办法所指源代码不仅限于公司开发人员自行编写实现功能的程序代码，而且还包括相应的开发设计文档及用于支撑整个系统运行所必须具备的第三方软件、控件和其它支撑库等文件。 2源代码完整性保障 1、所有软件的源代码文件及相应的开发设计文档均必须及时加入到指定的源代码服务器中的指定库中。 2、我们研发的产品软件运行所必须的第三方软件、控件和其它支撑库等文件也必须及时加入源代码服务器中指定的库中。 3、软件开始编写或者调整代码之前，其相应的设计文档和代码必须先从相应的SVN库进行SVNUpdate操作。软件编码或功能调整结束测试正确无误后，相应的源代码必须进行SVNCommit操作，在最终进行SVNCommit操作之前需要再进行SVNUpdate操作，查看是否有冲突产生，如果有冲突产生需要和冲突相关人一并解决冲突。 3源代码的授权访问 1、源代码服务器对于共享的SVN库的访问建立操作系统级的，基于身份和口令的访问授权。第十条在SVN库中设置用户，并为不同用户分配不同的，适合工作的最小

可行性研究报告软件需求说明书项目开发计划

软件工程之分析设计课程设计报告学院：计算机科学与技术学院专业：软件工程班级：0602班学号：06001647 姓名：马超（组长）同组人：路凯王志刚赵鑫指导教师：李爱萍宋春花时间：2009年6月

校内资源共享系统项目分工 1、概要分工： 2、详细分工：由于我们软件开发小组人员有限，并且时间有限，我们不可能让需求分析员，做完需求分析，就闲着；也不可能让测试师、编程人员在可行性研究阶段闲着。所以，我们在做每个阶段时，都是有明确分工的。让每个成员都参与，发挥各自的聪明才智，提出各自的主张，并进行激烈的探讨。在这种氛围下，我们提出了我们的产品目的，明确了产品的功能，完善了产品各方面的性能，并将各个模块的核心代码基本都落实，并最终结束了各方面的测试，完成了本系统的设计。

校内资源共享系统可行性分析报告 1 引言 1．1编写目的：可行性研究的目的是为了对问题进行研究，以最小的代价在最短的时间内确定问题是否可解。经过对此项目进行详细调查研究，初拟系统实现报告，对软件开发中将要面临的问题及其解决方案进行初步设计及合理安排。明确开发风险及其所带来的经济效益。本报告经审核后，交软件经理审查及软件开发人员分析。项目背景：开发软件名称：校内资源共享系统。项目任务提出者：项目组成员。项目开发者：王志刚路凯赵鑫马超。用户：学校全体师生。实现软件单位：太原理工大学网络中心项目与其他软件，office 播放器下载工具（如迅雷）：本项目采用B/S架构，客户端的程序是建立在Windows xp 系统上。以J2EE ORACLE为应用程序的开发软件，服务器端采用Windows工作站，是采用Oracle 10g的为开发软件的数据库服务程序。 1．3 定义： [专门术语]： Oracle10g: 系统服务器所使用的数据库管理系统（DBMS）。 SQL: 一种用于访问查询数据库的语言事务流：数据进入模块后可能有多种路径进行处理。主键：数据库表中的关键域。值互不相同。外部主键：数据库表中与其他表主键关联的域。 ROLLBACK: 数据库的错误恢复机制。 [缩写词]：格式化工厂：各种音频、视频、图片等格式转化的工具。 1．4 参考资料：《Oracle数据库基础》，贾素玲王强主编，清华大学出版社。《Web应用开发技术：JSP》，崔尚森张白一，西安电子科技大学出版社。《Java EE编程技术》，郝玉龙等编著２．可行性研究的前提要求主要功能：提供一个学校内师生信息共享的平台性能要求：服务器速度要足够快，以便能支持在线播放；磁盘阵列要足够大，以便存储下大家共享的信息。输出要求：数据完整，详实，流畅性好。输入要求：简捷，快速，实时，大家一起来维护。安全与保密要求：上传人员和管理人员有对信息的删除权限，个人的注册信息保密。完成期限：预计3个月，即截止２００9年9月 15日。

图纸编号规则

图纸编号规则文件号：ZH/QE-C06-01 版本：A/0 受控：编制：日期：审核：日期：批准：日期：

2015-3-26 发布2015-3-26 实施

文件修订记录

一、目的为规范图纸编号及图纸标题栏的编制方法，统一编号形式和标题栏的使用，特制订本规定。二、范围本规定适用于公司以下图纸编号的编制和标题栏的使用： 1、零部件图纸 2、电气图纸 3、结构图纸 4、安装布置图 5、外来图纸 6、任务单四、要求 1、每种产品、部件、零件的图纸应遵循“一件一号”的原则，均应有独立的编号； 2、同一产品、部件及零件的图纸用数张图纸绘出时，各张图纸号应相同。 3、通用件的编号可采用被通用件的图纸编号。 4、本公司出图的外购件、外协件，其图号由本厂给出；外购、外协件由外购、外协单位设计出图要由公司技术质保部给予验证确认，并给出公司内部图号。 5 、产品开发中如出现零、部件相互借用时，图纸的编号应按最先开发的产品图纸编号为准，借用关系应借用最先开发的产品，不准间接借用。 6、产品中通用性高，使用范围较广的零部件应尽快转换为通用

件。技术部门应编制通用件目录和通用件图册，供相关部门查阅使用。相关部门负责设计变更的申请与确认, 并依技术部发布的设计变更通知单内容配合相关工作的实施与落实。五、图纸编号的编制规则 1、电气图纸编号规则电气图纸编号按产品名称分类编号的方法进行编号，分类编号其代号的基本部分由图纸识别码、特征号（图纸分类代码）、分类号（产品分类码）、识别号（产品零部件顺序号）四部分组成。图纸分类含产品合同记录编号（《技术部工作流程记录表》编号）和图纸年份。产品类别代码见表 1。表 1 产品类别代码图纸分类代码用短横线隔开，用于同一项目中相同产品的不同图纸中图号的区分，采用数字、字母或数字加字母的形式进行编号；图

项目开发规范

项目开发规范 1.Java编程规范 1.1命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。 1.Package的命名：包的名字都由一个小写字母组成。 2.Class的命名：类名必须由大写字母开头，其它字母都小写的单词组成。 3.方法的命名：方法名必须由一个小写字母开始，后面的单词用大写字母开始。 4.变量的命名：变量名必须由一个小写字母开始，后面的单词用大写字母开始。 5.Static final变量的命名：static final变量的名字应该都大写,并且指出完整含义。 6.数组的命名：数组应该以byte [] buffer的形式，而不是byte buffer[]的形式定义。 1.2Java文件样式 1.版权信息：版权信息必须在java文件的开头，比如： /** *Copyright ? 2000 Shanghai XXX Co. Ltd. *All right reserved */ 2.数据库设计规范 2.1命名规范 1.数据库文件名：使用汉语拼音或者英文单词作为文件名，一律使用小写。 2.数据库表名称：数据库表名由前缀tb加实际名字组成，实际名字英文首字母大写 3.数据库表字段名称：每个单词首字母大写。 4.sql语句规范：所有sql语句关键词如：select，update等均大写。 3.网页设计约定 3.1命名规范 1.所有控件id号均由开发人员名称首字母作为前缀。 2.js代码命名规范参考java编程规范。 4.文档书写规范 4.1需求分析书写规范 1.目的和对象：简明编写需求说明书的目的，指明读者对象； 2.项目背景描述： a.项目的委托单位、开发单位和主管部门。 b.该软件系统与其他系统的关系，描述本项目的适应场合及处理业务。 c.项目名称：本项目的名称，包括项目的全称、简称、代号、版本号。 d.名称定义：列出文档中用到的专门术语的定义和缩写词的原文，对重要的或者有特殊意义的名词进行定义。 3.调研情况描述：描述主要的调研活动及对象。 4.用户特点： a.用户业务描述：描述适用本项目处理的业务。 b.用户情况：介绍本项目的用户情况，包括：用户的工作流程；用户的相关部门及职责；用户的技术水平；用户原有系统的情况：介绍用户现在使用的系统的主要情况，包括主要的不足。 5.任务概述

编码规范以开发手册范本

1.软件开发手册 1.1.围本标准规定了基于公司信息系统构建平台进行业务应用系统开发的编程格式规，主要包括命名规、代码注释、性能、以及常用语句的书写要求和约束等。统一规的格式有利于项目的交付和后续维护。 1.2.引言 1.1.1.简介所有的程序开发手册都包含了各种规则。一些习惯自由程序的人（例如 Java 程序员）可能对这些规则很不适应，但是在多个开发人员共同协作的情况下，这些规则是必需的。这不仅仅是为了开发效率，而且也为了测试和后期维护。良好的编码习惯有助于标准化程序的结构和编码风格，使源代码对于自己和别人都易读和易懂。在开发周期中越早使用恰当的编码规定，将会最大程度的提高项目的生产率。良好的编码习惯除了代码格式，详细的注释外，还应该包括使用有助于提高程序效率的编码方式。规的开发有助于提高源码的可读性，可维护性，对于提高项目的整体效率更是不可缺少的（尤其是团队开发）。 1.1. 2.目的本文是一套面向Java programmer 和Java developer进行开发所应遵循的开发规。按照此规来开发Java程序可带来以下益处： ●代码的编写保持一致性， ●提高代码的可读性和可维护性， ●在团队开发一个项目的情况下，程序员之间可代码共享， ●易于代码的回顾。 1.3.源程序 1.3.1.源程序命名 Java源程序的名字应该是这种形式：ClassOrInterfaceName.java。ClassOrInterfaceName 应该是在Java源程序中定义的 class或者interface的名字（关于classes和interface的命

名规请参考3.2）。源程序的文件名后缀通常为.java。 1.3. 2.供发布的文件如果文件编译后，需要用打包的形式发布，那么这个包的名字应该是有代表性的（例如应该是这个模块或者这个文件所在单元的名字）。通常包的扩展名有 *.jar(推荐使用)或者 *.zip、*.ear、*.war等。 1.3.3.源文件的组织一个Java源文件应该包含如下的元素，并按照以下顺序书写： 1)版本信息和声明 2)包的声明 3)引用声明 4)类或者接口的声明以上元素之间以至少一个空行来分隔。 1.3.3.1.版本信息和声明每一个源程序应该以一个包含版本信息和声明的块为开始。例如： /** * application name： sample1 * application describing： this class handels the request of the client * copyright： Copyright ? 2002 金质工程所有 * company： neusoft * time： 2002.02.25 * * author Brunce * version ver 3.1 */

软件项目开发计划

1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3定义 (1) 1.4参考资料 (1) 2项目概述 (1) 2.1工作内容 (1) 2.2主要参加人员 (1) 2.3产品 (2) 2.3.1程序 (2) 2.3.2文件 (2) 2.3.3服务 (2) 2.3.4非移交的产品 (2) 2.4验收标准 (2) 2.5完成项目的最迟期限 (2) 2.6本计划的批准者和批准日期 (2) 3实施计划 (2) 3.1工作任务的分解与人员分工 (2) 3.2接口人员 (3) 3.3进度 (3) 3.4预算 (3) 3.5关键问题 (3) 4支持条件 (3) 4.1计算机系统支持 (3) 4.2需由用户承担的工作 (3) 4.3由外单位提供的条件 (4) 5专题计划要点 (4)

项目开发计划（GB856T——88） 1引言 1.1编写目的说明：编写这份软件项目开发计划的目的，并指出预期的读者。 1.2 背景说明： a.待开发的软件系统的名称； b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； c.该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义列出本文件中用到的专门术语的定义和外文的首字母组词的原词组。 1.4参考资料列出用得着的参考资料，如： a.本项目的经核准的计划任务书和合同、上级机关的批文； b.属于本项目的其他已发表的文件； c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2项目概述 2.1工作内容简要地说明在本项目的开发中须进行的各项主要工作。 2.2主要参加人员扼要说明参加本项目开发的主要人员的情况，包括他们的技术水平。

项目开发计划管理制度

项目开发计划管理制度（试行）第一条目的为规范计划管理流程，提高整体计划管理质量，提高公司整体运作效率，制订本制度。第二条适用范围本制度适用于上海土地获取后项目开发计划的编制、执行与管理。第三条定义项目运营计划——获取新项目后上报总部决策（II）计划中明确的项目经营计划；项目年度指导性经营计划——年初（5月）根据公司次年年度经营指标制定的项目次年年度指导性经营计划；项目年度经营计划——年末（10月）根据公司次年年度经营指标制定的项目次年年度经营计划；项目开发节点计划（动态计划）——围绕项目开发确定的各阶段主要控制节点（70个节点）计划 A类节点——项目开发节点计划中的重要控制节点； B类节点——项目开发节点计划中关键路径上的重要任务，专业、部门间的主要接口工作；C类节点——项目开发节点计划中影响较单一的节点，其变化不影响后续重要节点。集团项目运营管理平台——一由集团开发综合项目工程、销售、成本、结算、规划、资源、资金等信息的管理平台。项目计划信息平台——由上海公司开发对项目开发主线上的主要工作时间节点进行集中管理的信息平台。上海沟通协作平台——由上海公司开发对沟通信息集中管理的信息平台。第四条计划管理职责 4.1 产品决策与计划管理委员会：负责指导公司各项目制定或修订项目年度经营计划；负责项目开发节点计划的审批与调整；负责项目A类开发节点计划的变更审批。 4.2 事业部/项目部：负责项目开发节点计划的编制与上报；负责项目开发各阶段的计划落实与协调；

4.2 工程管理部：负责项目开发节点计划的审核与备案；负责项目开发节点计划执行情况的跟踪、反馈及评估，参与重要配合工作的协调； 4.3财务管理部：负责对事业部/项目部年度经营计划进行审核并对执行情况进行监控； 4.4项目发展部：负责新项目获取阶段协调相关部门（工程、设计、营销等）根据公司年度经营指标制定项目运营计划，并于项目交底会时将项目运营计划移交事业部/项目部。 4.5 设计部、营销部等各职能部门：提供相关专业资源，支持项目经营计划落实；指导、协调专业性工作。第五条计划编制 5.1 集团决策计划：新项目获取阶段（项目立项后）由项目发展部跟据公司年度经营指标要求牵头各相关部门（工程/项目代表、设计、财务等部门参与）确定项目运营计划，通过项目决策会（十六级会议体系第六个会议）审批，作为当年计划考核基准版本。 5.2年度经营计划：通过经营计划会，公司以项目运营计划为基础确定项目各年度经营计划，作为项目开发计划实施的依据。 5.3项目各分期开发节点计划按照公司年度经营计划要求，由事业部/项目部组织相关专业编制项目各分期开发节点计划。 5.4 计划编制参照的内容 5.4.1 项目开发计划编制应首先考虑公司整体经营计划明确的节点要求；各事业部/项目部围绕公司经营计划节点对各阶段的工作进行统筹安排； 5.4.2参考工期作为编制项目开发计划的辅助信息，供计划编制人员参照建立起项目开发过程的初步框架，需要另外依据项目所处的不同环境及不同限定因素确定合理的附加工期。第六条计划审批项目开发节点计划经工程管理部审核后报工程总监或产品决策与计划管理委员会审批，工程管理部备案、发布，事业部/项目部录入项目运营平台及项目计划信息平台。

项目开发及编码规范

项目开发规范文档修订历史记录

1.简介目的 1、用于规范指导开发组进行开发 2、便于成员间的沟通与交流。 3、有助于项目质量和稳定。 4、为后期维护提供支持 2. 项目开发流程项目开发过程归纳分为以下步骤： 1. 建立SVN项目版本控制。包括文档，源码，Lib包等。 2. 了解需求，并对需求文档的书写。(见文档结构规则附录)。 3. 详细设计文档。(见文档结构规则附录)。功能模块设计，重要模块的算法设计。数据库设计等。根据需求定义开发平台及环境。 4. 编码。搭建开发平台，配置开发环境。编码。单元测试案例。 5. 书写软件安装手册文件，数据库脚本文件，以及注意事项(release notes)。 6. 交互测试组测试。根据测试组测试结果是否回归第4步（测试回归最好不要超过2 次）。 7. 测试通过，交付上线使用。维护手册使用手册

3. 代码规范 Java 代码规范 3.1.1 Java类名类名可由：英文字母，数字，下划线组成。（数字，下划线不能够开头）类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。类名要求首字母大写，多个单词组成类名时，单词的首字母要求大写。建议：类名不要过于简单或者太长。可以对单词采用简化的名称：入： Number 简化为：num 。 3.1.2 Java类结构类仅作为数据结构，没有行为，他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一，或者功能类似共有行为的。一个类不要过于庞大。通常情况下：一般逻辑类中应该有构造方法和main方法，main方法中应该有测试代码。每个类应该有 toString() 方法。 3.1.2.1 包和引入语句在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。报名的定义全部是小写字母。具体定义依据项目而定。引入包时候，同一类型的归纳到一块，用空行隔开。例如： import 3.1.2 类注释 Java类开头应该有相应的注释：类版本描述，作者签名，日期时间，公司备注，类的功能作用相关描述等。（详细查看：注释） 3.1.2.2 类成员变量 a) 类变量要求放在类的开始声明。一行声明一个。 b) 变量名称首字母要求小写。其他命名规则类似与类名。 c) static , final 类型的变量，字母要求全部大写。 d) 尽量在声明局部变量的同时初始化。 e) 避免局部变量和成员变量同名，覆盖了成员变量。 f) 尽量变量私有化，缩小变量的作用域。 3.1.2.3 类成员方法 a) 方法名命名规则类似于成员变量命名规则。 b) 成员方法尽量私有化。

产品开发项目计划说明书模板

目录 1 内容简介 (4) 1.1 文档目的 (4) 1.2 文档范围 (4) 2 项目概况 (4) 3 项目组织结构 (4) 4 项目依赖关系分析 (5) 5.1 项目关键路径分析及保障措施 (5) 5.2 项目依赖关系分析 (5) 5.3 项目关键成功因素 (6) 5.3 技术方法和工具 (6) 5 交付件 (6) 6 项目计划 (7) 6.1 项目的里程碑计划 (7) 6.2 项目WBS计划（highlevel计划） (9) 7 人力资源和技能需求 (9) 8 项目所需其它资源 (10) 9.1关键物料需求计划 (10) 9.2实验设备和环境资源计划 (10) 9 资料开发计划 (11) 10 对外合作计划 (11) 11 外包任务 (12) 10.1 子承包商资料 (12) 10.2 外包任务的范围 (12) 10.3 里程碑、交付件 (12) 12 预算/分配（可选） (12) 13 验收标准（可去掉） (12) 14 质量计划(也可单独成文档) (12) 12.1 项目过程定义 (13) 12.2 质量目标 (13) 12.3 通过技术手段保证质量 (13) 12.4 质量控制活动 (13) 12.5 质量保证活动 (15) 15 项目沟通计划 (15) 14.1 项目组会议 (15) 14.2 项目报告机制 (16) 16 项目的重用计划 (16) 15.1 现有重用构件 (16) 15.2 新增重用构件 (16) 17 配置管理计划 (17) 18 问题 (17) 19 风险管理计划 (17) 20 客户的参与 (18) 21 培训计划 (18)

常用图纸编号规则及图纸要求

1 常用图纸编号规则及图纸要求、图纸编号规则简介: 说明: 1产品类型：由产品名称的几个主要字母组成; 2、产品型号：由产品的主要特征参数 +产品型号区分码（A 、B C ?……Z ）组成; 3、一级装配件：总机装配下的第一级子装配件，可编范围“ 01?? (99) 例：“ CNFSQH2O-O1OOOO-OOO0表示总机装配下的第一个子装配件; 4、二级装配件：一级装配件下的子装配件，可编范围“ 1.? (9) 例：“CNFSQH2O-O11OOO-OOO0表示总机装配下第一个子装配件下的第一个子装配件; 例：“CNFSQH2O-O1OO1O-OOO0表示总机装配下第一个子装配件下的第一个子焊接件; 6、二级焊接件；一级焊接件下的子焊接件，中编范围“ 1.?…9 ”；例：“CNFSQH2O-O1OO12-OOO0表示总机装配下第一个子装配件下的第一个子焊接件的第二个子焊接件； 7、零部件区分代码：当该图表示的为零件时用“ 1”表示，当该图表示的为装配件或焊接件时用“ 0”表示； 8、零件代码：各装配件或焊接件下的零件，可编范围“ 01??…99 ”；例：“CNFSQH20-010000-101。表示总机装配下的第一个子装配件下的第一个零件； 9、版本代码：产品定型后有部件或零件需要进行设计更改时，通过改变该数字进行区分可编范围“ 1 ??…9 ” 例：“ CNFSQH20-010000-1011表示总机装配下的第一个子装配件下的第一个零件的第一次更改版本；二、图纸要求； 00 O — 版本代码零件代码 O 丨零部件区分代码二级焊接件代码 00 00 2 CNFSQH 一级焊接件代码二级装配件代码一级装配件代码产品类别代码 ?产品类别代码例：“20”其后面没有区分码表示基本型, 20A ”表示A 型; 5、一级焊接件：总机装配或一级、二级装配件下的第一级子焊接件, 可编范围“01?? (99)

项目开发计划

二、项目开发计划目录 1．引言 (1) 1.1编写目的 (1) 1.2项目背景 (2) 1.3定义 (2) 1.4参考资料 (2) 2．项目概述 (2) 2.1工作内容 (2) 2.2条件与限制 (2) 2.3产品 (3) 2.3.1程序 (3) 2.3.2文档 (3) 2.4运行环境 (3) 2.5服务 (3) 2.6验收标准 (4) 3．实施计划 (4) 3.1任务分解 (4) 3.2进度 (4) 3.3预算 (4) 3.4关键问题 (4) 5．交付期限 (5) 6．专题计划要点 (5) 1．引言 1.1编写目的本报告的主要作用是确定各个项目模块的开发情况和主要的负责人,供各项目模块的负责人阅读,做到及时协调,按步有序进行项目的开发.减少开发中的不必要损失. 具体步骤：拟订开发计划书，分配项目工作，安排项目进度。计划对象：软件一班14开发小组。

1.2项目背景项目名称：药库管理系统。项目任务提出者：张朋项目开发者：张朋，任蒙爱，周景，彭慧超，赵莺歌。项目使用者：全体学生和老师。 1.3定义 1.4参考资料《软件工程导论》，《C# 》《数据库》《c#项目开发实例》 2．项目概述 2.1工作内容各开发人员根据时间先后安排，分别对项目进行开发各项主要工作：软件开发人员对调查结果进行分析，拟订实现方案（如程序结构，流程，数据结构等）。软件编程人员对软件进行集中开发。软件审核人员对软件进行评定，审核。 2.2条件与限制完成项目应具备的条件： ●开发平台 ●开发基础设施 ●开发人员 ●维护人员开发单位已具有的条件： ●开发基础设施

项目编码规范编写指南

项目编码规范 1 命名规范 1）.包名采用域后缀倒置的加上自定义的包名，采用小写字母。在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。格式： com.huawei.产品名.模块名称 com.huawei.部门名称. 项目名称示例： Relay模块包名 com.huawei.msg.relay 通用日志模块包名 com.huawei.msg.log 2）. 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。示例： OrderInformation, CustomerList, LogManager, LogConfig 3）. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。示例： 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 修饰。示例： public final static int MAX_VALUE = 1000; public final static String DEFAULT_START_DATE = "2001-12-08"; 7). 属性名可以和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。示例： public class Person { private String name; private static List properties; public void setName (String name) { https://www.360docs.net/doc/c010380650.html, = name; } public void setProperties (List properties) { Person.properties = properties; } } 8).如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。示例： getCustomerInformation() 改为 getCustomerInfo() 2 程序注释规范 1)、基本注释（必须加）

项目开发计划模板

项目开发计划 (仅供内部使用) 文档作者：____________________ 日期：____/____/____ 开发/测试经理：____________________ 日期：____/____/____ 产品经理：____________________ 日期：____/____/____ 管理办：____________________ 日期：____/____/____ 请在这里输入公司名称所有不得复制

项目开发计划 1 引言 1 .1编写目的本开发计划的目的是： a．把在开发过程中对各项工作的人员、分工、经费、系统资源条件等问题的安排用文档形式记载下来，以便根据本计划开展和检查本项目工作，保证项目开发成功； b．制订项目组开发过程中的评审和审查计划，明确相应的质量管理负责人员；规定软件配置管理的活动内容和要求，明确配置管理工作的人员。特别要求：需求分析必须详细，并且有相关专家合作进行， 1 .2背景本项目软件名称为《电能质量数据分析软件》。任务来源于（略）公司；交办单位：（略）公司；承办单位：长峰新康科技XX公司。 1 .3参考资料无； 1 .4术语和缩写词暂无；特别说明：有关公司内部秘密的内容用（略）代替。 2 任务概要 2 .1工作内容本项目开发过程中需要进行的各项主要工作为：编制附和软件需求要求的软件功能的软件。文档计划建立：软件开发计划；软件目录软件需求规格说明项目开发计划可行性报告

软件标准规X 软件测试计划软件测试办法概要设计说明软件可靠性和安全性设计指南硬件总体设计报告详细设计说明软件详细设计报告软件代码（略）测试分析报告软件可靠性和安全性设计检查单软件评审检查单软件使用说明 2 .2产品 2 .2.1程序见需求。 2 .2.2文档文档内容见2.1中文档建立。文档格式要求按照软件模式化要求进行，模式按照如下名称模板要求规定：软件开发计划→项目开发计划；文档目录→软件目录；需求分析报告→软件需求规格说明；概要设计文档→概要设计说明；详细设计文档→详细设计说明；源代码→软件标准规X；软件使用说明书→软件使用说明；软件测试报告→测试分析报告；软件审查报告→软件评审检查单。 2 .2.3服务培训：时间：1天；内容：软件使用及安装；软件支持：略。

机械图号编写规则

图纸编码及填写规范技术部王峰一、目的加强对技术部文件、图纸的管理,使设计、工艺文件管理有规可寻,实现资源共享。二、适用范围适用于技术部所有设计、工艺图纸的编码及管理。三、定义本制度所述的技术文件包括产品零件图、装配图、工装、量具图,试制流程图、工艺规程、检验卡片、作业指导书、质量记录、文件资料等。四、一般要求 4、 1 每个产品、部件、零件的图样与文件均应有独立的代号。 4、 1、1 采用表格图时,表中每种规格的产品、部件、零件都应标出独立的代号。 4、 1、 2 同一产品、部件、零件的图样用数张图纸绘制时,各张图样标注同一代号。 4、 1、3 同一CAD文件使用两种以上的存储介质时,每种存储介质中的CAD文件都应标注同一代号。 4、 1、4 通用件的编号应参照JB/T5054、8 或按企业标准的规定。 4、 1、5 借用件的编号应采用被借用件的代号。五、主要内容 1、软件的使用技术部机械制图统一采用 AutoCAD(2D),Solidworks(3D);具体版本由技术部商讨决定。 2、图纸编号规则 1）产品编号 XXX·XX ·XX

序号产品代号公司代号 2）零件图编码规则产品编号:参照1); 特征码(可增加): 零件图——L; 装配图——Z; 装配流程图——P; 工装夹具图——J; 版本号:从A-Z进行编号; 零件号:从01-99进行编号。 3）装配图编码规则产品编号:参照1); 特征码:参照2); 版本号:从A-Z进行编号; 零件号:从01-99进行编号。 4）工装夹具图编码规则产品编号:参照1); 特征码:参照2); 版本号:从A-Z进行编号; 零件号:从01-99进行编号。 5）装配流程图编码规则

java项目团队开发规范

项目团队开发规范

修订历史记录

目录 1引言 (6) 1.1 编写目的 (6) 1.2 预期读者 (6) 1.3 编写背景 (6) 2概述 (7) 2.1 目标 (7) 2.2 修改及完善 (7) 3详细规范 (7) 3.1 使用的工具 (7) 3.2 框架设计 (7) 3.3 包目录 (8) 3.4 编码规范 (10) 3.4.1 目的 (10) 3.4.2 依据 (10) 3.4.3 具体规范 (10) 3.4.3.1 编码风格 (10) 3.4.3.1.1 缩进 (10) 3.4.3.1.2 空格 (11) 3.4.3.1.3 对齐 (12) 3.4.3.1.4 空行 (12)

3.4.3.1.5 代码长度 (13) 3.4.3.1.6 行数 (13) 3.4.3.1.7 注释 (14) 3.4.3.2 代码效率 (17) 3.4.3.2.1 综述 (17) 3.4.3.2.2 具体实现 (17) 3.4.3.3 异常处理 (17) 3.4.3.3.1 处理CHECK 异常与UNCHECK异常 (17) 3.4.3.4 程序调试 (17) 3.4.4 日常交流 (18) 3.4.4.1 互相促进 (18)

1引言 1.1 编写目的本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。 1.2 预期读者本文档的预期读者包括以下几类： ?项目组长 ?项目组全体成员 1.3 编写背景根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。

项目开发计划和需求分析

项目开发计划的编写提示 B.1 B.1.1引言编写目的说明编写这份项目开发计划的目的，并指出预期的读者。 B.1.2背景说明： a、待开发的软件系统的名称； b、本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； c、该软件系统同其他系统相互关系。 B.1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 B.1.4参考资料列出用得着的参考资料，如： a、本项目的经核准的计划任务书或合同、上级机关的批文； b、属于本项目的其他已发表的文件； c、本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 B.2 B.2.1项目概述工作内容简要地说明在本项目的开发中须进行的各项主要工作。 B.2.2主要参加人员

扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。 B.2.3产品 B.2.3.1 程序列出需移交给用户的程序的名称，所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。 B.2.3.2 文件列出需移交给用户的每种文件的名称及内容要点。 B.2.3.3 服务列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持的级别和服务的期限。 B.2.3.4 非移交的产品说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。 B.2.4验收标准对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。 B.2.5 完成项目的最迟期限 B.2.6 本计划的批准者和批准日期 B.3 实施计划 B.3.1工作任务的分解与人员分工对于项目开发中需完成的各项工作，从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作，用户培训工作，软件安装工作等，按层次进行分解，指