stag-java快速上手指南

《stag-java快速上手指南》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、Stag-Java快速上手指南深圳市施泰信息技术有限公司StagJava快速上手指南StagJavaCodingQuickGuideVersion1.0KimShieh2014/9/12编程不是艺术，而是一项工程活动。对于任何工程项目来说，统一的施工标准都是保证工程质量的重要因素。高品质、易维护的软件开发离不开清晰明确的编码规范。8/9Stag-Java快速上手指南修订历史修改人修改内容时间版本号KimShieh起草、编写2014.9.13Ver1.08/9Stag-Java快速上手指南目录1概述31.1书籍推荐32

2、命名约定42.1文件和目录42.2代码43代码风格与版式64注释74.1普通注释74.2文档化注释88/9Stag-Java快速上手指南1概述本指南根据《Stag-Java编码规范》内容，抽离出具体的代码模板并加以点评，以帮助新同事快速熟悉主要的编码规范点，以便尽快地投入到项目中。本指南仅仅是编码规范的一个子集，侧重于代码的风格和版式。更多为了避免深层次的Bug而推出的编程习惯、技巧和规则，请参考完整的《Stag-Java编码规范》。1.1书籍推荐下面列出一些评价非常高的著作，对于高质量编程具体非凡的指导意义，希望大

3、家在紧张的工作中，抽出一些时间进行学习、积累和沉淀：l《Java编程思想》（关注怎样编程）l《代码大全》（编程经验积累）l《编程之美：微软技术面试心得》（关注有趣算法）l《设计模式：可复用面向对象软件的基础》（关注设计和架构）l《敏捷软件开发：原则、模式与实践》（关注项目过程）l《人月神话》（关注项目管理）8/9Stag-Java快速上手指南1命名约定1.1包包名全部采用小写字母，包名中不能出现下划线，并且第一个字母不能是数字。1.2代码文件：DscpDevice.h使用#define防止头文件被多重包含。格式：

4、ROJECT>___H_#ifndefDSCP_DEVICE_DSCP_DEVICE_H_#defineDSCP_DEVICE_DSCP_DEVICE_H_#include"Common/Types.h"使用相对于项目根目录的相对路径。路径分隔符使用/，而不是避免使用绝对路径，避免使用.或..#include"DncpStack/DncpStack.h"#include"DNCP/App/DscpController.h"#include"DscpMonitor.h"#include"Dsc

5、pMsg.h"/***@briefDSCP设备对象，用于操作指定的一个设备。*@note本节点基于DNCP的TRP路由协议，通信之前不建立连接。类型名称都使用PascalCase风格，包括：类、结构/联合体、枚举、名字空间、typedef等*/classDscpDevice{public:DscpDevice(Uint8d1,Uint8d2,Uint8d3=0,Uint8d4=0);~DscpDevice(void);方法名称使用PascalCase风格，按业务功能命名，使用有意义的动词或动宾短语public:voi

6、dSetTimeout(intmillisecond);public:boolSend(Uint16cmdCode,void*data=NULL,Uint16len=0);变量名采用camelCase风格，除了第一个单词外，所有单词首字母大写DscpRespExpectResp(Uint16respCode);Uint16ExpectStatus(Uint16respCode);DscpEventExpectEvent(Uint16eventCode);类成员变量使用m_前缀；全局变量使用g_前缀；静态变量使用s_前

7、缀；private:8/9Stag-Java快速上手指南DeviceAddressm_deviceAddress;intm_timeout;};#endif//DSCP_DEVICE_DSCP_DEVICE_H_文件：DscpDevice.cpp#include"DscpDevice.h"宏和枚举值的命名采用UPPER_CASE风格，即所有字母都大写，单词之间使用下划线分隔。#defineDEVICE_PORT_NUM12enumAlternateUrlTableErrors{OK,OUT_OF_MEMORY,MAL

8、FORMED_INPUT,常量名称采用camelCase风格，但应使用常量前缀k；常量命名不使用类型前缀，通常也不使用范围前缀};constintkDaysInAWeek=7;/**变量不使用类型前缀，也不使用指针前缀。错例：uiCmdCode、pData、szText*@brief发送命令到设备，阻塞调用。*@param[in]cmdCode