《JAVA代码规范》(二)通用代码格式 - 文件组织(2.1)

2019-03-28 17:25|来源: 苦力工

2       通用代码格式

2.1      文件组织

一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读,应该尽量避免。

Java源文件必须遵循以下规则:

?        文件头部注释

所有的源文件都应该在开头有一个C语言风格的注释,其中列出文件名、作者、公司、日期、描述、修改说明和版权声明:

/*

* File:    OrderSessionBean.java

* Author:  ajava.org-苦力工

* Version:  1.1

* Date:    03/08/2008

* Modify:

* Description:

* Copyright notice

*/

?        包和引入语句

Java源文件中,第一个非注释行是Package语句。Package 行要在 Import 行之前,Import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。例如:

  package java.awt;

 import java.awt.peer.CanvasPeer;

 import java.io.InputStream;

 import cn.edu.cuit.TestApplication;

?        类和接口声明

下表描述了类和接口声明的各个部分以及它们出现的先后次序

序号

/接口声明的各部分

注解

1

/接口文档注释(/**……*/)

该注释中所需包含的信息。

2

类或接口的声明

3

/接口实现的注释(/*……*/)如果有必要的话

该注释应包含任何有关整个类或接口的信息,而这些信息又不适合作为类/接口文档注释。

4

类的(静态)变量

首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。

5

实例变量

首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。

6

构造器

7

方法

这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

本文链接:领悟书生教程网,转自ajava.org

相关问答

更多
  • Eclipse 3.6允许您通过放置特殊注释来关闭格式化 // @formatter:off ... // @formatter:on 在Eclipse首选项中必须打开/关闭功能: Java > Code Style > Formatter 。 单击编辑 , 关/开标签 ,启用启用开/关标签 。 还可以在首选项中更改魔术字符串 - 在此处查看Eclipse 3.6文档 。 更多信息 Java > Code Style > Formatter > Edit > Off / On Tags 此偏好设置允许您定 ...
  • Eclipse带有一个强大的内置代码格式器,可以对其进行非常详细的定制。 查看“首选项”菜单。 Eclipse comes with a powerful builtin code formatter that can be customized in great detail. Look in the Preferences menu.
  • 同名的类需要在不同的包中 。 您可以使用导入来避免必须键入完整路径( packagename.ClassName ),但如果您不创建单独的包,则无法明确地引用您所指的类。 在超过中等规模的代码库中,这很快变得不可行。 所以,不,单独的文件是不够的。 Classes of the same name need to be in different packages. You can use imports to avoid having to type the full path (packagename.C ...
  • 如果你使用eclipse,请尝试: 窗口> Prefferences> Java>编辑器>保存操作 选中“在保存时执行所选操作”,“其他操作”并单击“配置”。 使用eclipse的Save Actions在真实生活编码中可能非常有用,但您可能会通过Save Actions向导学习一些整洁的java技巧。 Java是一种面向对象的语言。 你需要利用这个事实。 使用类将您的代码分隔成不同的逻辑/结构组件。 了解如何使用OOP。 遵循SOLID设计和使用设计模式 。 另一个重要的事情是要知道你的语言 。 首先阅读 ...
  • 尝试使用更具体的正则表达式。 只需在表达式末尾添加$符号即可。 $符号表示行尾或字符串结尾。 它看起来像这样: { $ext -match '(jpg|png|gif|bmp)$'} { "images" } 你可以通过打开PowerShell和输入来轻松测试: "abc.csv" -match '(cs|xls)$' 这将导致False。 Try using a more specific regular expression. Just add $ signs at the end of your ...
  • 所有JVM内部都记录在JVM规范和相应的更新中: 版本5之前的Java JVM规范 Java 5 VM的规范更新 Java 6 VM的规范更新 更具体地说,在Java 5中引入了ACC_BRIDGE标志。请参见更新的类文件格式的第4.7节。 All JVM internals are documented in JVM specification and corresponding updates: JVM spec for Java before version 5 Spec updates for Ja ...
  • 您可以在DEV模式下更改响应标头: http : //rockyj.in/2013/04/01/building_single_page_applications_and_cors.html 如果您在另一台服务器上运行资产,或者将/ assets / *上的所有请求重定向到您的其他服务器,我看不到您可以执行的任何其他操作。 You can change the response header in DEV mode: http://rockyj.in/2013/04/01/building_single_p ...
  • 这被诊断为由扩展字符集引起,导致换行被误解,并通过使用UTF8显式写入文件来解决。 请参阅如何在Android上读取和写入UTF-8到磁盘? 1 This was diagnosed as being caused by extended character sets causing line-breaks to be misinterpreted and was solved by explicitly writing the file using UTF8. See How to read and wr ...
  • 在大于2.0的elasticsearch版本中,ImmutableSettings不可用 如果您使用它来创建传输客户端,则可以使用 TransportClient transportClient = TransportClient.builder()。build(); transportClient.addTransportAddress(new InetSocketTransportAddress(InetAddress.getByName("127.0.0.1"), 9300)); I ...
  • 显然,Java 6 Update 4是JAXB 2.1( 源代码 )附带的第一个版本。 Apparently Java 6 Update 4 was the first version to ship with JAXB 2.1 (source).