Java编程规范手册

网道Java编程规范

一、目的：

本规范立足于所收集到的各种Java编码标准、规范、惯例以及指导性原则，根据本公司的具体情况进行调整后制定而成，其目的是便于软件代码易于理解、维护以及重用。更为重要的事，遵循这些标准可以显著地提高软件生产率。

记住：编码是具有集体性质的，其易读性、易维护性是编码优良的重要评判标准。

二、原则

1．尽量添加注释。

2．为人编码，而不是为电脑编码。

3．先做设计，然后编码。

4．保持代码简单。

5．从小到大编制。切忌一上手就编制大规模代码。

三、基本规范

1．注释

在Java中，存在三种注释，分别为：

●文档注释：/**………*/；

●多行注释：/*………*/；

●单行注释：//。

这三种注释将用于不同的位置。

1.1 原则

●尽可能进行代码注释。

●力求注释简洁、清楚、易懂。

●先写注释，再写代码

●除了注释代码功能外，更为重要的是注释出为什么要这样做，便于别人知道你写这段代码的目的。

1页

2页

3页