可编辑,
4.5.4按钮
css类统一为：styleClass="btn" 或class="btn"；其中原“…”按钮改为如下形式，
需要着重标记的字可加class=”notice”例如：*
或 合计
4.5.6 Javascript新增函数
1）hide（objName）隐藏一个对象。
2）show（objName）显示一个对象。
3）is_numeric(str1)：判断表达式是否是数字。
4）is_int（str）：判断是否是整数。
5）jstrim（str）：去掉字符串两边的空格。
6）open_window(url,win_name,width,height)：打开一个名为win_name，网址为URL的网页，打开窗口的高度为height，宽度为width。
7）check_year(objName)：检测ID为OBJ的对象的值是否为4位YEAR。
8）check_month(objName)：检测ID为OBJ的对象的值是否为月份。
项目编码规范 项目代码编程规范 1.应用范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。 创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法
软件项目代码编码规范 变更履历
目录 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库中设置用户，并为不同用户分配不同的，适合工作的最小
编码规范以开发手册范本 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、用于规范指导开发组进行开发 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 命名规范 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/8312090386.html, = name; } public void setProperties (List properties) { Person.properties = properties; } } 8).如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。 示例： getCustomerInformation() 改为 getCustomerInfo() 2 程序注释规范 1)、基本注释（必须加）
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 编写背景 根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。
软件开发项目管理 管理目标 1、所有关系人清晰明确地了解项目的需求和期望，努力做到满足项目所有关系人的不同需求；项目关系人包括：项目团队成员和项目团队外(内部/外部客户，内部/外部合作伙伴，经销商/客户等)。 2、项目管理三要素平衡（时间/成本/质量），即开发项目按需按时按质的完成。 3、目标：功能满足需求，设计支持变化，开发快速迭代，成果持续交付。 执行概述 1、建立有效的工作流程保证项目的顺利进行，初期使用传统RUP过程，引入部分敏捷方法， 团队磨合完成后逐步实现敏捷开发全流程管理。 2、明确项目目标，制定具有可行性的项目计划，有效明确的分解项目需求。 3、跟踪设计/开发/测试/回归/发布全流程，推动项目按预定计划执行。 4、解决项目过程中出现的问题和冲突，一般集中在需求不明/工作量或时长/开发难度/跨 部门协调等几个方面。 5、调动开发团队的积极性，创造力，推动团队成员在项目过程中的学习成长。 6、风险识别、风险控制以及风险的预案。 项目管理 1、需求阶段 对项目进行技术可行性分析、技术评估、成本评估以及风险评估。 与需求提出方的代表进行需求讨论，明确项目的目标、价值。 确定项目范围、功能及优先级。 组建项目团队，特别要搞清楚项目的关键人。 项目启动会议，相关的关系人都必须参加。 2、设计阶段 根据确认后的软件需求规格说明书，制定项目进度计划，工作任务分解(WBS)；资源申请，项目涉及到的开发资源、测试资源、设计资源(包括人员和软硬件资源)；数据库设计；系统设计；文档(包括系统用例、Demo、测试用例等)；评审会议。 设计阶段结果交付一般为系统用例/系统原型/系统设计文档(概要设计和详细设计)/数据库设计文档等。 该阶段交付成果需要进行评审。 3、执行阶段(开发和测试) 准备开发环境、测试环境。 跟踪，推动项目按计划进行。 项目成员以日报/项目负责人以周报的形式通报各关系人当前项目的进展情况。 按里程碑对阶段成果进行评估，以确保该阶段完成的质量。 代码审核，包括CS审核、SQL审核、WEB审核等。 对需求变更进行控制管理。 测试阶段BUG响应及改进、收集反馈意见。 对项目风险进行管理。 4、发布阶段 包括制定项目发布计划，用户培训，发布上线。 5、试运行阶段 数据监控(日志、服务器状态)，根据监控出现的问题，及时进行处理，改进性能问题，特定情况执行补丁升级。
研发部需求开发规程管理 精心整理 管理目标 1、所有关系人清晰明确地了解项目的需求和期望，努力做到满足项目所有关系人的不同需求；项目关系人包括：项目团队成员和项目团队外(内部/外部客户，内部/外部合作伙伴，经销商/客户等)。 2、项目管理三要素平衡（时间/成本/质量），即开发项目按需按时按质的完成。 3、目标：功能满足需求，设计支持变化，开发快速迭代，成果持续交付。 执行概述 1、 2、 3、跟踪设计/开发/测试/回归/ 4、/跨部门协 调等几个方面。 5、 6、风险识别、风险控制以及风险的预案。 项目管理 1、需求阶段 2 根据确认后的软件需求规格说明书，制定项目进度计划，工作任务分解(WBS)；资源申请，项目涉及到的开发资源、测试资源、设计资源(包括人员和软硬件资源)；数据库设计；系统设计；文档(包括系统用例、Demo、测试用例等)；评审会议。 设计阶段结果交付一般为系统用例/系统原型/系统设计文档(概要设计和详细设计)/数据库设计文档等。 该阶段交付成果需要进行评审。 3、执行阶段(开发和测试) 准备开发环境、测试环境。
跟踪，推动项目按计划进行。 项目成员以日报/项目负责人以周报的形式通报各关系人当前项目的进展情况。 按里程碑对阶段成果进行评估，以确保该阶段完成的质量。 代码审核，包括CS审核、SQL审核、WEB审核等。 对需求变更进行控制管理。 测试阶段BUG响应及改进、收集反馈意见。 对项目风险进行管理。 4、发布阶段 包括制定项目发布计划，用户培训，发布上线。 5、试运行阶段 数据监控(日志、服务器状态) 定情况执行补丁升级。 6、收尾阶段 产品交付，项目总结会。 常见问题 1、开发时间的估算 算，通常单个模块开发时间取决于以下因素： 1 2(包括对框架和应用的熟悉程度)。 3 开发者没有相关的代码可以参考，自己也没有经验， 1、在划分好模块后，首先项目管理人员预先估算各个模块所需要的开发时间。 2、召集所有开发人员，讨论模块的分配和开发时间估算。将划分好的模块，分配给开发人员，如状况允许可允许开发人员自主选择以提高开发人员的主动性和参与性。分配模块的时为确保开发的速度和质量，基本原则如下： A、类似的模块由同一人负责开发，比如用户信息的增删改应由同一开发者负责。这样开 发者对相关逻辑会比较熟悉，代码/接口的定义也会相对明确，沟通的成本低，相应可以降低功能实现的缺陷概率。 B、技术难度较大的模块由技术水平比较高的人负责。 C、业务逻辑比较复杂的由对业务逻辑比较了解的人负责。
软件项目开发计划 项目开发计划书 项目名称：9号智能鲜柜网站系统软件项目编号：*** 编写人员：____ 编写日期：2004-5-10 _ 审批人员： 审批日期：
历史修改记录
1.引言 (4) 1.1.编写目的 (4) 1.2.项目标识 (4) 1.3.项目背景 (4) 1.4.术语定义 (4) 1.5.参考资料 (4) 1.6.约束和假定 (5) 2.项目概况 (5) 2.1.项目产品 (5) 2.1.1.交付产品 (5) 2.1.2.非交付产品 (5) 2.1.3.维护和服务 (5) 3.开发规程、标准和方法 (5) 3.1.规程和标准 (5) 3.2.生命周期选择 (5) 3.3.开发语言和编程工具 (6) 4.规模和成本估计 (6) 4.1.项目规模 (6) 4.2.项目工作量和成本 (6) 5.资源需求 (6) 6.人员组织和安排 (7) 7.项目进度计划 (8) 8.用户应承担的工作 (9) 9.风险评估和防范 (9)
1.引言 1.1.编写目的 编写本文档的目的是为实施工程和管理软件项目制定合理的计划，为实施和管理软件项目活动提供基础，并根据软件项目资源、约束条件和能力向软件项目的的客户提出承诺。 本文档的读者为：高级项目经理、项目经理、项目开发组、测试经理、测试组、质量保证组。 1.2.项目标识 项目名称：部门级文档管理系统。 1.3.项目背景 本项目由开目公司提出立项，经英诺有限公司审批通过，由英诺有限公司负责开发工作。 本项目的用户是对文档有管理需求的企业。 本项目的目的是开发一个文档管理系统，对部门内的纸质文档和小型局域网内的电子文档进行入库、出库、版本更新的管理，提供文档信息的查询和定位服务，并根据用户所在的组织和用户的权限确定用户对不同文档的操作权限。 1.4.术语定义 1.5.参考资料 部门级文档管理系统立项申请报告 部门级文档管理系统需求规格说明书 软件配置管理计划指导书 软件质量保证计划指导书
PRD产品开发项目 管理规范 产品开发项目文档管 理规范 文档编号：COSHIP-CMMI-PRD-PDPDM 密级：机密 版本信息：1.8 批准日期： 编辑软件：Microsoft Word 2003 Microsoft Visio 2003 同洲电子股份有限公司版权所有 内部资料注意保密
*变化状态：C――创建，A——增加，M——修改，D——删除
目录 1 概述 (1) 1.1 目的 (1) 1.2 适用范围 (1) 2 产品开发文档体系 (1) 3 文档质量的度量准则 (3) 4 主要角色和职责 (3) 4.1 文档作者 (3) 4.2 项目经理 (4) 4.3 PPQA (4) 4.4 配置管理工程师 (4) 4.5 评审组 (4) 4.6 部门经理 (4) 5 文档审核流程 (5) 5.1 审核流程 (5) 5.2 归档签名 (6) 5.3 纳入基线 (6) 6 文档保密制度 (7) 7 文档编号 (7) 7.1 文档编号规则 (7) 7.2 阶段代号 (8) 8 文档版本 (9)
1概述 1.1 目的 规范公司产品开发项目的文档体系，加强文档的标准化管理。 1.2 适用范围 公司内所有产品开发项目。 2产品开发文档体系 在产品开发项目开发过程中，各阶段都有相应的文档输出，文档的编写应先于或同步于开发工作。 产品开发项目过程中的文档体系如表1所示。 表1.产品开发项目文档体系
3文档质量的度量准则 评审文档质量的度量准则有以下六条： 完整性：所承担产品开发任务的项目组，需按照公司文档体系的规定编写相应的文档，以保证在项目结束时其文档是齐全的。 正确性：在项目各个阶段所编写的文档的内容，必须真实的反映阶段的工作且与该阶段的需求相一致。文档与所述的对象保持一致，必要时应进行实时的文档版本升级。 可读性：文档应该表达清晰、逻辑条理分明、表现形式通用。 简明性：在项目各个阶段所编写的各种文档的语言表达应该准确简练。 规范性：文档的规范性是指采用当前最新的模板。其完整性及内容的充实程度应不低于模板的要求。 可追溯性：在项目各个阶段所编写的各种文档应该具有良好的可追溯性。由于各开发阶段编制的文档与各阶段完成的工作有着密切的关系，前后阶段生成的文件，随着开发工作的逐步扩展，具有一定的继承关系。在一个项目各开发阶段之间提供的文件必定存在着可追溯的关系。 4主要角色和职责 4.1 文档作者 文档作者包括公司内的项目组成员以及外协人员。文档作者在文档方面的主要工作为：1）在项目开发过程的各个阶段中，按照规定及时地完成项目文档的编写工作，文档作者有责任保证文档编写与开发同步。 2）文档作者不仅要审核文档字面上有无错漏，还要审核所陈述的技术内容是否精确，及表达方式上是否清晰易懂。文档作者对文档的正确性、可读性和规范性全面负责。 3）文档作者保证所编写的文档与所描述的对象保持很好的一致性，必要时及时更新文档，便于以后维护工作和后续开发工作的开展。
软件开发编码规范 软件开发编码规范(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 语句格式与语句书写规范 (6) 4.2.1 括号 (6) 4.2.2 保留字和关键字 (7) 4.2.3 函数 (7) 4.2.4 变量 (7) 4.2.5 语句 (7) 5 命名规范 (9) 5.1 函数命名 (9) 5.2 形参 (9) 5.3 常量和变量 (9) 5.3.1 常量和宏定义 (9) 5.3.2 变量 (9) 5.4 函数使用说明、接口命名、NameSpace命名 (10) 5.5 控件的命名 (11) 5.6 类型 (11) 5.6.1 一般类型 (11) 5.6.2 构造类型 (12) 5.6.3 类类型 (12) 5.7 文件和文件夹 (12) 5.7.1 文件夹的命名规则 (12) 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行,个别特殊函数除外。 代码中打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 应尽量使用.NET库函数和公共函数(无特殊情况不要使用外部方法调用windows的核心动态链接库)。 一般情况下，不得使用全局变量，尽量使用局部变量。 2.2可读性要求 可读性第一，效率第二。（这仅对代码本身而言）。 保持注释与代码完全一致。
Java开发编码规范 项目管理体系文件Java开发编码规范 编撰人： 审核人： 批准人： 批准日期：2014-3-10 保密级别：公开 文档版本：0.0.1 重庆中软国际信息技术有限公司
版本历史
目录 第一章代码开发规范及其指南 (1) 1.1目的 (1) 1.2程序内命名规范 (1) 1.3文件命名规范 (2) 1.4J A V A 文件样式 (2) 1.5代码编写格式 (6) 第二章程序编写规范方法 (8) 2.1权限修饰 (8) 2.2其他规范 (8) 2.3编程指南 (10) 第三章其他要求 (12)
第一章代码开发规范及其指南 1.1 目的 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 1.2 程序内命名规范 ●Package的命名：Package 的名字应该都是由一个小写单词组成。 ●Class 的命名：Class 的名字必须由大写字母开头而其他字母都小写的单词 组成 ●Class 变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大 写字母开头。 ●Static Final 变量的命名：Static Final 变量的名字应该都大写，并且指出完 整含义。 ●参数的命名：参数的名字必须和变量的命名规范一致。 ●数组的命名：数组应该总是用下面的方式来命名：byte[] buffer; 而不是 byte buffer[]; ●方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字 段一样的名字： SetCounter(int size){ this.size = size; }
java开发编码规范 Java 命名约定。 采用适用于相关领域的术语 采用大小写混合使名字可读 尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一 避免使用长的名字（一般小于15个字母） 避免使用类似的名字，或者仅仅是大小写不同的名字 避免使用下划线（除静态常量等） 包（Package） 采用完整的英文描述符，应该都是由小写字母组成。对于全局包，将你的Internet 域名反转并接上包名。例如：java.awt,com.ambysoft.www.persistence 类（Class） 采用完整的英文描述符，所有单词的第一个字母大写（一些专有的缩写词，比如：AWTException等则除外）。Class的名字建议使用名词或者名词短语。例如：Customer, SavingsAccount，LayoutManager等 接口（Interface） 接口的名字取决于接口的主要功能和用途。如果接口是使对象具有某种特定的功能，则接口的名字建议使用可以描述这种功能的形容词（加上-able或者-ible 后缀） 例如：Searchable，Sortable，NetworkAccessible等 如果接口不是使对象具有某种特定的功能则建议使用名词或者名词短语（同类的命名规则）。 组件/部件（Component） 使用完整的英文描述来说明组件的用途，末端应接上组件类型。okButton, customerList,fileMenu 异常（Exception） 通常采用字母 e 表示异常。 类变量字段 采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。firstName, lastName 静态常量字段（static final） 全部采用大写字母，单词之间用下划线分隔。MIN_BALANCE, DEFAULT_DATE 方法 方法命名采用大小写混合的形式。以小写字母开头，名字中其他单词的首字母以大写字母开头，所有其它的单词都为小写字母，不要使用下划线分隔单词。方法的命名应该能描绘
项目编码规范 项目编码规范 (一)命名规范 Java包、类的命名应尽量采用完整的英文描述符,一般采用小写英文字母,但类名、接口名以及任何非初始单词的第一个字母要大写,不能用完整英文描述的,应以该英文单词的前四个字母或能代表单词意思的缩写代替。具体如下: (1)尽量使用完整的英文描述符; (2)采用合适于相关领域的术语 (3)采用大小写混合使名字可读 (4)尽量少用缩写,确有需要的,要能表达其意义; (5)避免使用长的名字(小于15个字母) (6)避免使用类似的名字,或者是大小写不同的名字; (7)避免使用下划线(除静态常量等); 举例如下: 包(packge) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的internet域名反转并接上包名。如:com.boyi.eim,com.boyi.oa.web 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。 如:User,StuManager 接口(interface) 采用完整的英文描述符说明接口封装,所有单词第一个字母大写。名字后面加上后缀Dao,实体类实现接口加上后缀Impl
类变量:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。如:userName 参数:同上 获取成员函数:封装字段,被访问时调用get set方法 普通成员函数:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。 静态常量字段:全部采用大写字母,单词之间用下划线分隔。 循环计数器:通常采用字母I,j,k…………….. 数组:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写 (二)代码注释 良好的注释习惯对于一支程序来说,是其易于解读的关键。也就是说,如果另一个编程人员从未见过这段代码,要在合理的时间内理解代码,需要知道哪些信息。并以此作为注释的依据。因此对于注释来说,需要注意以下几点: (1)注释应该增加代码的清晰度; (2)保持注释的简洁; (3)在写代码之前写注释 (4)注释出为什么做了一些事,而不仅仅是做了什么 使用代码注释的目的: (1)文字说明代码的作用(即为什么要用编写该代码,而不是如何编写);
国家重点XXXX项目--代码开发规范 附件四 国家发展改革委网上办公系统二期项目 代码开发规范 编制单位：北京AAAA信息产业股份有限公司 编制人： 编制日期：二○一一年四月
目录 第1章前言 (1) 1.1 目的 (1) 1.2 内容 (1) 1.3 定义 (2) 1.4 适用范围 (2) 第2章JAVA源码编写规范 (2) 2.1 标识符的命名规范 (2) 2.2 公认的命名约定 (3) 2.3 源文件注释的规范 (3) 2.3.1 Java中的注释类型 (3) 2.3.2 历史信息说明 (4) 2.3.3 类头部注释 (4) 2.3.4 变量常量注释 (5) 2.3.5 方法头部注释 (5) 2.3.6 代码注释 (5) 2.4 文档排版的规范 (6) 2.4.1 缩进 (6) 2.4.2 空格和空行 (6) 2.4.3 页面宽度 (7) 2.4.4 长参数表达式的换行 (7) 2.4.5 括号的匹配 (8) 2.4.6 import语句 (8) 第3章JSP源代码规范 (9) 3.1 页面目录结构 (9) 3.2 文件命名规范 (10) 3.3 HTML文件样式 (11) 3.4 使用标签代替Java编码 (12) 3.5 表单显示规范 (12) 3.6 缩进和对齐 (13) 3.7 注释 (14) 3.8 JavaScript文件 (14)
第1章前言 1.1 目的 为规范国家发展改革委网上办公系统二期项目（以下简称“发改委二期项目）系统的开发代码管理，特制定开发代码规范。通过该规范，我们希望达到以下目标： 1.增加开发过程代码的强壮性、可理解性、易维护性；减少有经验和无经验 开发人员编程所需的脑力工作； 2.在项目范围内统一代码风格； 3.使新的开发人员快速适应项目氛围； 4.更好的完成发改委二期项目的开发，以及后期的维护。 1.2 内容 本规范采用与国际代码规范基本一致的代码规范，并使得能在开发阶段将代码规范落实到项目组中的每一个有关人员。统一代码开发规范，提高代码的质量和可维护性。 提供事务、异常处理、文件处理等标准服务，规范各模块的处理方法。 制订代码开发规范，撰写核心代码规格及单元测试指针以建立测试导向的开发目标。 本规范包括对以下两个部分的规范要求：Java源文件和JSP源文件。将JSP 单独提出作为一部分加以规范，目的是为了让JSP源代码符合SUN提出的标准，而不是像一个Java文件。 规范主要分为以下几个个方面： 1.手工编写代码时需要注意的部分，如命名和注释； 2.代码排版时需要注意的部分，如缩进，换行等。这一部分可通过编辑器辅 助实现； 3.其它的一些问题，如某些技巧和常用解决方案。
项目编码规范 项目开发规则
C#命名规范 1.1命名空间 框架中所有命名空间的起始部分COM.ACCP 业务中所有命名空间的起始部分COM.ASSEMBLY.FOLDER 实际结构和名称以业务为准 1.2类 1)名字应该能够标识事物的特性。 2)名字可以有两个或三个单词组成，但通常不应多于三个。 3)采用Pascal case，所有单词第一个字母大写。 4)使用名词或名词短语命名类。 5)少用缩写。 6)不要使用下划线字符(_)。 例： public class FileStream public class Button 1.3接口 和类命名规范相同，唯一区别是接口在名字前加上“I”前缀 例： interface IDBCommand interface IButton 1.4枚举 和类命名规范相同，唯一区别是枚举在名字前加上“E”前缀 例： enum ESystemType 1.5方法 1)使用动词或动词短语命名方法。 2)采用Pascal case，所有单词第一个字母大写。 3)方法中的参数命名采用Camel casing,所有单词第一个字母大写，除了首字母小写。 1.6属性 1)使用名词或名词短语命名 2)采用Pascal case，所有单词第一个字母大写 3)少用缩写 4)不要使用下划线字符( _ )
1.7变量 1)变量名称= 变量的前缀+ 代表变量含意的英文单词或单词缩写。 常用变量类型的前缀命名规则，定义如下： 常用对象: 2)类的私有变量，在遵循第一条规则后，在其前加“m_”前缀。 例: public class Hello { private string m_strName; public string Name { get { return m_strName; } }
JAVA开发编码规范 JAVA项目开发编码规范 一、目的 对于代码，首要要求是它必须正确，能够按照程序员的真实思想去运行；第二个的要求是代码必须清晰易懂，使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域，源程序的风格统一标志着可维护性、可读性，是软件项目的一个重要组成部分。而目前还没有成文的编码风格文档，以致于很多时候，程序员没有一个共同的标准可以遵守，编码风格各异，程序可维护性差、可读性也很差。通过建立代码编写规范，形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性，可以保证程序代码的质量，继承软件开发成果，充分利用资源，使开发人员之间的工作成果可以共享。 本文在参考业界已有的编码风格的基础上，描述了一个基于 Eclipse 的项目风格，力求一种统一的编程风格，并从整体编码风格、代码文件风格、函数编写风格、变量风格、注释风格等几个方面进行阐述。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 二、整体编码规则 1、缩进 缩进建议以4个空格为单位。建议在 Tools/Editor Options 中设置 Editor 页面的Block ident为4，Tab Size 为8。预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。语句块的"{"、"}"配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个"{"、"}"单独占一行，便于匹对。JBuilder 中的默认方式是开始的"{"不是单独一行，建议更改成上述格式（在 Project/Default Project Properties 中设置 Code Style 中选择 Braces 为 Next line）。 2、空格 原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( ... 等。运算符的空格规定如下："::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"（指正负号）、"&"（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符"?:"两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。","运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对
项目代码编写规范 目录 1.包命名规范 (2) 2.类命名规范 (3) 一、基本命名规范： (3) 二、注释规范 (4) 3.Jsp页面命名 (6)
项目代码编写规范 代码编写规范目的：能够在编码过程中实现规范化，为以后的程序开发中养成良好的行为习惯。 1.包命名规范 目的：包的命名规范应当体现出项目资源良好的划分 自定义标签类所在包命名规范：com.项目名称(小写).tags 例如：com.xxxxx.web.tags 过滤器类所在包命名规范：com.项目名称(小写).web.filter 例如：com.xxxxx.web.filter Action类所在包命名规范：com.项目名称(小写).web.action 例如：com.xxxxx.web.action Controller类所在包命名规范：com.项目名称(小写).controller 例如：com.xxxxx.controller Javabean所在包命名规范：com.项目名称(小写).entity 例如：com.xxxxx.entity DAO类所在包命名规范：com.项目名称(小写).dao.impl 例如：com.xxxxx.dao.impl DAO类所实现的接口在包中命名规范：com.项目名称(小写).dao 例如：com.xxxxx.dao 业务逻辑实现接口命名规范：com.项目名称(小写).service.impl 例如：com.xxxxx.service.impl 业务逻辑实现接口命名规范：com.项目名称(小写).service 例如：com.xxxxx.service 全局工具类所在包命名规范：com.项目名称(小写).util 例如：com.xxxxx.util
开发编码规范 JAVA编码规范v1.0
目录 1.关于 (3) 2.项目结构 (3) 2.1命名空间 (3) 2.2源文件 (3) 2.3文件目录存放 (3) 3.命名约定 (4) 4.排版 (5) 5.Java文件格式 (6) 6.注释规范 (6) 7.代码编译 (8) 8.性能 (8) 9.测试及维护 (9) 10.异常 (9) 11.编程技巧 (10) 1）使用 StringBuffer 对象 (10) 2）避免太多的使用 synchronized 关键字 (10) 3）避免使用 java.util.Vector 类 (10) 4）面向接口编程 (10) 5）避免使用索引来调用数据库中间层组件返回的结果集 (11) 6）对于自己创建的每一个类，都考虑置入一个main() (11) 7）应将方法设计成简要的、功能性单元 (11) 8）设计一个类时，请设身处地为客户程序员考虑一下 (11) 9）使类尽可能短小精悍，而且只解决一个特定的问题。 (12) 10）采用内部类 (12) 11）采用注释 (12) 12）避免使用"魔术数字" (12) 13）接口和抽象类的使用 (12) 14）日志调试 (13) 12.JSP编码规范 (13) 13.日志框架 (14) 14.事务处理 (16)
1.关于 本文档以JAVA编程语言为基础，提供编码规范的指导，以统一开发人员的书写标准，提高代码的可读性。 代码体系、接口规约、命名规则等，这是项目小组今后共同作战的基础，有了编码规范和程序模块之间和项目成员彼此之间的接口规则、方式方法，大家就有了共同的工作语言、共同的工作平台，使整个软件开发工作可以协调有序地进行。 2.项目结构 2.1命名空间 每个命名空间对应一个目录。采用完整的英文描述符，应该都是由小写字母组成。对于全局,将你的Internet 域名反转并接上包名如java.awt,com.ambysoft.www.persistence。全局命名空间下的其它则按照功能进行划分,每个功能包下则按照放置的不同文件性质进行设置。 2.2源文件 以类名作为文件名。一个文件只应该有一个命名空间，避免将多个类或命名空间放在同一个文件里面：一个文件除去IDE产生的代码后最好不要超过500行的代码，一个方法的代码长度最好不要超过25行，超出后应考虑拆分代码或重构以降低耦合;每行代码不要超过80个字符;避免方法中有超过5个参数的情况。如果超过了,则应将参数封装为类或集合类型进行传递。 2.3文件目录存放 JSP存放目录按子系统存放，同一子系统中的JSP文件不再分设单独的目录。 图片存放目录为”/images”，JS文件存放目录为：专用的JS文件和jsp文件在同一目录下，公用的放在”/js”下；所有的样式表都存放在”/css”下； 子系统目录采用完整的英文描述说明，第一个单词的首字母小写，其他单词
