本文介绍的是日本的软件开发规约,主要涵盖了系统整体、开发环境、文件结构、命名规则、功能构成、编码规范等方面,旨在提供一套值得借鉴的软件开发标准。
1. 开发环境
- 系统服务器端采用Windows Server 2003操作系统和MSDE数据库。
- 开发终端推荐使用Windows XP Professional Edition SP2(日语版),分辨率设定为1280x1024(管理员)或1024x768(租户),并使用Visual Studio .NET 2005 (.NET Framework 2.0)作为开发工具,以及Visual SourceSafe 2005作为版本控制系统。
2. 文件结构
- 遵循SRC为根目录的相对路径原则,包括APP_DATA、JA、CSS、JS等子目录,用于存放应用数据、日语资源、样式表、JavaScript文件等。
- BIN目录存储Release构建的执行文件,COMMON目录存放通用函数的源代码,CONFIG目录则用于配置XML文件。
3. 命名规则
- Web表单前缀为程序ID,如Tenant_Login。
- 模块类以"M_"开头,如M_InputNum。
- 类以"C_"开头,如C_InputNum。
- 共通控件前缀为程序ID,如Page_Tab_Control。
- 除上述规定外,不允许使用其他未列出的前缀,且禁止省略前缀。
4. 功能构成
- 使用"#Region"指令进行代码分组,根据功能用途将代码段置于不同的区域中,便于管理和阅读。
5. 编码规范
- 包括头文件、过程声明、行宽、代码块和变量类型等方面的指导。
- 头文件应包含必要的注释和文档。
- 过程声明要清晰,易于理解其功能。
- 行宽建议不超过一定限制,以保持代码的可读性。
- 代码块要结构清晰,适当使用缩进。
- 变量类型应明确,避免使用隐式类型。
这套日本软件开发规约体现了对代码组织、命名、结构和质量的严谨要求,有助于提高开发效率,降低维护成本,是软件开发团队可以参考的最佳实践。通过遵循这些规约,开发者可以编写出更易读、更易于维护的代码,提升整体项目管理的质量和效率。