Java 编程指南

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

1、先锋软件股份有限公司【Java编程标准】/【TS-G-01】Java编程指南文档编号：TS-G-02***软件股份有限公司-内部资料，注意保密-第2页共10页***软件股份有限公司【Java编程指南】/【TS-G-02】文件变更记录*A-增加M-修订D-删除变更版本号日期变更类型（A*M*D）修改人变更摘要备注V1.0-内部资料，注意保密-第5页共55页***软件股份有限公司【Java编程指南】/【TS-G-02】目录JAVA编程指南11简介11.1最根本的原则：12程序设计标准12.1命名约定12

2、.1.1注释约定22.1.1.1Java注释语句类型32.1.1.2快速浏览javadoc53成员函数标准63.1命名成员函数63.2命名存取成员函数63.2.1.获取函数63.2.2.获取函数的另一种命名约定。Has和Can73.2.3.设置函数73.3.命名构造函数83.4.成员函数的可见性83.5.注释成员函数83.5.1.成员函数的函数头83.5.2.内部注释103.6.编写清晰整洁的代码的技巧123.6.1.给代码加上注释123.6.2.让代码分段/缩进123.6.3.遵循30秒条法则13

3、3.6.4.写短小单独的命令行133.6.5.说明运行顺序134.字段标准（字段/属性）134.1命名字段144.1.1.命名组件（部件）144.1.2.命名组件的另一种方法。匈牙利符号144.1.3.命名组件的另一种方法。匈牙利符号后缀154.1.4.命名常量154.1.5.命名集合154.2.字段可见性16-内部资料，注意保密-第5页共55页***软件股份有限公司【Java编程指南】/【TS-G-02】4.2.1.不要“隐藏”名字164.3.注释一个字段174.4.使用存取成员函数174.4.1

4、.为什么使用存取函数？184.4.2.命名存取函数194.4.3.存取函数的高级技术194.4.3.1.滞后初始化194.4.3.2.常量存取函数214.4.3.3.集合存取函数244.4.3.4.同时访问几个字段244.4.4.存取函数的可见性254.5.一定要初始化静态字段255.局部变量标准255.1声明命名局部变量265.1.1.命名流265.1.2.命名循环计数器265.1.3.命名异常对象265.2.声明并注释局部变量275.2.1.关于声明的一般注释276.成员函数的参数标准276.1

5、命名参数276.1.1注释参数287.类、接口、包和编译单元的标准287.1类的标准297.1.1.命名类297.1.2.注释类297.1.3.类的声明307.1.4.将公共和保护接口最小化317.2接口标准317.2.1.命名接口327.2.1.1可替代的其它办法：327.2.2.注释接口327.3包的标准327.3.1.命名包337.3.2.注释包337.4编译单元标准337.4.1命名编译单元347.4.2注释编译单元34-内部资料，注意保密-第5页共55页***软件股份有限公司【Java编程

6、指南】/【TS-G-02】8.错误处理和异常349.其他标准和版本369.1复用369.2导入类369.3优化Java代码369.4编写Java测试集3710.成功的模式3810.1有效地使用这些标准3810.2其它导向成功代码的因素3911.总结4011.1Java命名约定4111.2Java注释约定4311.2.1Java注释类型4311.2.2注释哪些部分4411.3Java程序设计约定（一般）4612.词汇表47-内部资料，注意保密-第5页共55页***软件股份有限公司【Java编程指南】/

7、【TS-G-02】Java编程指南1简介本文提供一整套编写高效可靠的Java代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个Java软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。1.1最根本的原则：运用常识。当找不到任何规则或指导方针，当规则明显不能适用，当所有的

8、方法都失效的时侯：运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少的。2程序设计标准Java的程序设计标准很重要，原因在于它将提高开发团队各成员的代码的一致性。一致性的提高会使代码更易理解，这意味着它更易开发和维护。从而降低了应用程序的总开发成本。你必须牢记的是：你的Java代码在你已离开并开始另一个项目之后，会保留相当长的一端时间。因此开发过程中一个很重要的目标就是要确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编