Java 编码规范 (转)[@more@]

编码规范:namespace prefix = o ns = "urn:schemas--com::office" />

翻译:王士勇

(转载请保留作者,谢谢)

1.  引言

1.1  为什么要编码规范

编码规范为什么是重要的?有以下一些理由:

l  一份80%的生命周期是维护期

l  任何软件都很难说他的整个生命周期都是由他的原始作者来维护

l  编码规范改善软件的可读性,使得软件工程师充分理解新的代码变得非常的。

l  如果你要把你的原码作为产品发布,你需要确保他像你的其他产品一样干净并且封装的好。

为了按照规范工作,每个人写软件的时候,都必须遵守编码规范。记住,是每个人!

1.2  致谢

这本书是反映的是Java Language Specification 中关于java语言编码规范的。在这里要着重对Peter king ,Patrick Naughton,Mike DeMoney,Jonni Kanerva,Kathy Walrath,和tt Hommel表示感谢。

2.  名

这一节列出了本书所用的大部分文件名和后缀。

2.1 文件后缀

.java  java 源文件后缀

.class   java 字节码文件后缀

2.2 常用的文件名

经常使用的文件名包括以下:

makefile    首选的makefile的名字,我们使用gnumake来build我们的软件。

README   那些专门概述特定文件夹内容的文件的首选的名字

3.  文件的组织

一个文件的各个部分之间应该用空行隔开,并且应该用一个可选的注解来标示每个不同的部分。

文件超过2000行,是非常笨重讨厌(cumbersome)的,应该避免。

至于java 的正确格式的示例,请参看18页上的”JAVA File Example(Java 原码文件示例)”。

3.1 Java 源码文件

每一个Java源码文件都包括一个唯一的public 类或interface。当私有的类和interface 都和这个public 类有关联时,你可以把它们放到这个public 类的源文件中。这个public 类或interface 应当是这个文件的第一个类或interface 。

Java 源文件有以下的顺序:

l  文件开头注解(参见第二页的“Beginning Comments(开头注解)”)

l   声明package 的语句和载入语句。

l  类和interface的声明(参见page 3的“Class and Interface Declarations”)

3.3.1 开头注解

所有的源文件都应该以一个C语言风格的注解开头。这个注解应该列出类名,版本信息,日期和版权声明:

/*

*Classname

*

*Version information

*

* Date

*

* copyright notice

*

*/

3.1.2 声明包的语句和import 语句

绝大多数java 源文件中的第一非注释行应该是声明包的语句。此后,紧接着是import 语句。例如:

package java.awt;

import java.awt.peer.Canveer;

3.1.3 类和接口的声明

下面的表格描述了部分的类和接口的声明,他们应该按照表格的顺序。参看“Java Source File Example” on page 18 。

java编码规范概述_Java 编码规范 (转)相关推荐

  1. java编程规范换行_Java编程规范整理

    近期即将开始编码阶段,特地整理一下各方面的编程规范与命名约定,以便内部团队风格统一. 文章大多从网络上收集汇总而来,参考列表附在文章末尾. Java编程规范整理 基本命名规范 包命名 包名按照域名的范 ...

  2. java servlet乱码问题_Java编码和servlet乱码问题(1)-Java编码

    在写这边文章时,在网上扒拉了很久,发现好多博客总结的都非常好,我也是参考了很多,在文章最后会列出一些觉得不错的博客地址,大家如果有兴趣可以去看看. 本篇主要是简单介绍Java编码知识,如果已经非常了解 ...

  3. java内存模型概述_Java内存模型-快速概述和注意事项

    java内存模型概述 在计算中, 内存模型描述了线程如何通过内存交互,或更一般地,它指定了为分段内存或分页内存平台生成代码时允许编译器进行的假设. 在给定程序和该程序的执行跟踪的情况下,它实质上描述了 ...

  4. java标签组件命名_java编程规范之java命名规范

    想要成为一个优秀的程序员,首先要培养良好的编程习惯,为了提高代码的可读性,必须有好的命名规范. 这篇文章是小编结合网上的很多资料整理出来的,若有不当或错误的地方,欢迎大家指正 在文章开始前,为方便阅读 ...

  5. java的命名规则_Java命名规范

    命名规范 本规范主要针对java开发制定的规范 项目命名 项目创建,名称所有字母均小写,组合方式为:com.leadal.$projectName.$component.$hiberarchy. $p ...

  6. Java消息中间件的概述与JMS规范

    原文链接:https://blog.51cto.com/zero01/2120351 转载于:https://www.cnblogs.com/Wbin01/p/10945747.html

  7. java图形用户界面概述_Java中图形用户界面概述

    Java中图形用户界面概述,转型或者高薪就业,java工程师是不错的选择,而且java是目前乃至未来都主流的程序语言.Java中图形用户界面概述,一起来学习下java方面的知识吧. 1.1.组件 组件 ...

  8. Java编码规范,在您进行编码之前应该阅读的规范

    为什么80%的码农都做不了架构师?>>>    本文转载于:http://www.web3d.com.cn/new/teach/java3d/2006/11/13/363276161 ...

  9. 程序员你为什么这么累【续】:编码习惯之工具类规范

    导读: 程序员你为什么这么累? 我的编码习惯 - 接口定义 我的编码习惯 - Controller规范 我的编码习惯 - 日志建议 我的编码习惯 - 异常处理 我的编码习惯 - 参数校验和国际化规范 ...

  10. java判断字符串是什么编码_java可供判断某字符串是什么编码的一行代码

    System.out.println("中文"); System.out.println("中文".getBytes()); System.out.printl ...

最新文章

  1. 信息学奥赛一本通 1102:与指定数字相同的数的个数 | OpenJudge NOI 1.6 01
  2. 征服 Ajax 应用程序的安全威胁
  3. 安卓学习笔记14:安卓手势操作编程
  4. HighCharts中几种tooltip的显示格式
  5. Windows平台内核级文件访问
  6. 简单说几个常见的数据结构
  7. C# 创建、读取Excel公式
  8. WordPress获取当前网站域名
  9. 湖南科技大学web课程设计之网页聊天室的实现
  10. 【SpringBoot】MultipartResolver文件解析器
  11. Node.js的环境搭建方法和 npm 的使用方法
  12. html页面执行sql语句,关于在页面上执行sql语句
  13. linux fuse 性能,分布式文件系统---fuse挂载类性能测试
  14. jacob 给word 指定位置添加超级链接
  15. mysql list类型_数据库list是什么类型数据
  16. 下载中转站downloadTransport
  17. 思岚科技让服务机器人移动智能化
  18. nodejs下载及安装(windows)
  19. php rsa 证书生成工具,RSA公私钥快速生成和RSA证书快速创建利器
  20. java获得某进程CPU占用率

热门文章

  1. redis实现分布式锁代码片段
  2. 支持向量机(Support Vector Machine,SVM)—— 线性SVM
  3. linux awk使用详解
  4. 5.hbase表新增数据同步之add_peer
  5. 测试驱动开发(一)-我们要的不仅仅是“质量”
  6. Lambda 表达式(C# 编程指南)
  7. 超像素 Superpixel
  8. Python在指定文件夹生成随机文件
  9. 从零基础入门Tensorflow2.0 ----四、13.生成csv文件
  10. Pytorch——用50行代码搭建ResNet