开发规范与要求.pdf

【开发规范与要求】 开发规范是软件开发过程中不可或缺的一部分，旨在确保代码的可读性、可维护性，提高软件质量和生产效率，减少错误，并保证完整的软件产品编码和文档。以下是一些关键点： 1. **目的**： - **良好编程习惯**：培养良好的编码习惯是确保代码质量的基础，这包括代码整洁、逻辑清晰。 - **易读性**：代码应清晰易懂，以便其他团队成员能快速理解其功能和用途。 - **易维护性**：编写可维护的代码可以降低长期维护成本。 - **提高质量与生产率**：遵循规范可以减少调试时间和修复错误的工作量。 - **避免编码错误**：通过规范约束，减少因人为疏忽造成的编码错误。 - **完整编码与文档**：提供完整的源码和文档，便于团队协作和后期维护。 2. **要求**： - **严格执行规范**：所有源代码必须遵循此规范，以保持一致性。 - **注释规范**：每个程序文件都应包含注释，注释内容需按照规定书写，以便他人理解代码。 - **英文单词**：编码时使用标准英文单词，禁止使用中文拼音。 - **名词单数形式**：名词应使用单数形式，除非有特殊需要。 - **大小写混合命名**：使用驼峰命名法，除常量和模块级变量（m_*）外避免使用下划线。 - **命名限制**：变量和函数名字长度控制在3至20个字母内。 - **避免缩写**：除非必要，尽量避免使用缩写，若使用，应参照附录的缩写范例。 3. **开发工作要求**： - **每日签入**：下班前必须将所有可编译通过的代码签入版本控制系统。 - **获取最新代码**：每天早上获取最新的源代码，确保工作基于最新版本。 - **文件签入与注释**：添加新文件后立即签入并添加注释，包括创建时间、作者和功能描述。 - **界面一致性**：保持页面、CSS和按钮风格的一致性。 - **文件目录组织**：根据项目需求建立独立的目录结构，例如HR项目在OA基础上开发，需创建独立的HR目录。 - **模块化目录**：细化模块下的子模块功能目录。 - **文件命名**：采用主谓结构，首字母大写，名称应准确反映其用途。 - **命名空间**：遵循特定产品命名规则，如LinkPower.PduOA6.Mod.WorkFlow。 - **常量命名**：常量以c_*开头，如c_intNumDaysInWeek。 - **标签与样式**：HTML标签中的label用于字段，CSS和JS集中管理，控件样式统一由CSS控制。 4. **书写排版规范**： - **空格缩进**：避免使用TAB字符，采用4个空格缩进，保持代码整洁。 - **HTML标记与属性**：HTML标记和属性全小写，属性使用双引号，以符合XHTML标准。 - **空行使用**：适当使用空行增强代码可读性，逻辑相关的语句之间不加空行，其他地方适当分隔。 以上规范对于提升开发效率和软件质量至关重要，遵循这些规则能够帮助团队构建高质量、易于维护的软件系统。