快速上手指南.docxVIP

Stag-Java快速上手指南 PAGE3 / NUMPAGES8 深圳市施泰信息技术有限公司 Stag Java快速上手指南 Stag Java Coding Quick Guide Version 1.0 Kim Shieh 2014/9/12 编程不是艺术，而是一项工程活动。对于任何工程项目来说，统一的施工标准都是保证工程质量的重要因素。高品质、易维护的软件开发离不开清晰明确的编码规范。 修订历史 修改人 修改内容 时间 版本号 Kim Shieh 起草、编写 2014.9.13 Ver 1.0  目 录 TOC \o 1-2 \h \z \u HYPERLINK \l _Toc 1 概述 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 1.1 书籍推荐 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 2 命名约定 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.1 文件和目录 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.2 代码 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 3 代码风格与版式 PAGEREF _Toc \h 6 HYPERLINK \l _Toc 4 注释 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 4.1 普通注释 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 4.2 文档化注释 PAGEREF _Toc \h 8  概述 本指南根据《Stag-Java编码规范》内容，抽离出具体的代码模板并加以点评，以帮助新同事快速熟悉主要的编码规范点，以便尽快地投入到项目中。 本指南仅仅是编码规范的一个子集，侧重于代码的风格和版式。更多为了避免深层次的Bug而推出的编程习惯、技巧和规则，请参考完整的《Stag-Java编码规范》。 书籍推荐 下面列出一些评价非常高的著作，对于高质量编程具体非凡的指导意义，希望大家在紧张的工作中，抽出一些时间进行学习、积累和沉淀： 《Java编程思想》（关注怎样编程） 《代码大全》（编程经验积累） 《编程之美：微软技术面试心得》（关注有趣算法） 《设计模式：可复用面向对象软件的基础》（关注设计和架构） 《敏捷软件开发：原则、模式与实践》（关注项目过程） 《人月神话》（关注项目管理）  命名约定 包 包名全部采用 包名全部采用小写字母，包名中不能出现下划线，并且第一个字母不能是数字。 代码 文件：DscpDevice.h 使用 #define 防止头文件被多重包含。格式： 使用 #define 防止头文件被多重包含。 格式：PROJECT_PATH_FILE_H_ #define DSCP_DEVICE_DSCP_DEVICE_H_ #include Common/Types.h 使用相对于项目根目录的相对路径。路径分隔符使用 / ，而不是 使用相对于项目根目录的相对路径。 路径分隔符使用 / ，而不是 \ 避免使用绝对路径，避免使用 . 或 .. #include DNCP/App/DscpController.h #include DscpMonitor.h #include DscpMsg.h /** * @brief DSCP 设备对象，用于操作指定的一个设备。 * @note 本节点基于DNCP的TRP路由协议，通信之前不建立连接。 类型名称都使用 类型名称都使用PascalCase风格，包括：类、结构/联合体、枚举、名字空间、typedef等 class DscpDevice { public: DscpDevice(Uint8 d1, Uint8 d2, Uint8 d3 = 0, Uint8 d4 = 0); ~DscpDevice(void); 方法名称使用PascalCase风格 方法名称使用PascalCase风格，按业务功能命名，使用有意义的动词或动宾短语 void SetTimeout(int millisecond); public: bool Send(Uint16 cmdCode, void* data = NULL, Uint16 len = 0); 变量 变量名采用camelCase风格，除了第一个单词外，所有单词首字母大写 DscpResp ExpectResp(Uint16 respCode); Uint16 ExpectStatus(Uint16 respCode); DscpEvent ExpectEvent(Uint16 eventCode);