资讯专栏INFORMATION COLUMN

3-文件组织

Miracle_lihb / 1787人阅读

摘要:文件组织一个文件由应以空行分隔的部分和标识每个部分的可选注释组成。一个文件超过行的代码会显得很麻烦,应该避免出现这样情况。源代码文件每个源文件包含一个多带带的公开类或者接口。构造函数方法这些方法应该按照功能而不是范围或可访问性进行分组。

3-文件组织

一个文件由应以空行分隔的部分和标识每个部分的可选注释组成。

一个文件超过2000行的代码会显得很麻烦,应该避免出现这样情况。

3.1 java 源代码文件

每个源文件包含一个多带带的公开类或者接口。如果这个公开类有关联的私有类或者接口,可以把他们放在同一个文件里,必须放在公开类的下面。

java源文件的内容有以下几部分:

头部注释(参考:)

包的声明和导入声明

类和接口声明

3.1.1 头部注释

所有源文件应以c样式注释开头,其中列出了类名,版本信息,日期和版权声明:

/*
 * 类名
 *
 * 版本信息
 *
 * 日期
 *
 * 版权声明
 */
3.1.2 包的声明和导入声明

大多数Java源文件的第一个非注释行是一个package语句。之后,可以进行import语句。例如:

package java.awt;

import java.awt.peer.CanvasPeer;
3.1.3 类和接口声明

下表按照它们应该出现的顺序描述了类或接口声明的各个部分。

顺序 类和接口声明 描述
1 类/接口 文档注释(/**...*/) 参考 "文档注释" 了解该评论应该包含哪些内容。
2 类/接口 声明
3 类/接口的实现注释(/*...*/), 可省略 这种注释包含所有不适合放在类/接口文档注释的其他信息
4 类(静态) 变量 首先是public 类变量,然后是protected,然后是包级别(无访问修饰符),最后是private
5 实例变量 首先是public 类变量,然后是protected,然后是包级别(无访问修饰符),最后是private
6 构造函数
7 方法 这些方法应该按照功能而不是范围或可访问性进行分组。例如,私有类方法可以位于两个公共实例方法之间。目标是让阅读和理解代码更容易。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/69354.html

相关文章

  • 使用混合云文件系统来满足组织的存储需求

    摘要:它被称为混合云文件系统,它使用本地部署的小型硬件客户端来存储文件元数据,并在后台自动与云端同步。结论通过将本地部署环境的物理组件与云计算系统的组件相结合,混合云文件系统使组织能够真正获得两全其美的优势。如今,越来越多的企业正在将数据迁移到云中,以利用无需采购或维护大量硬件相关的成本、可扩展性和效率的优势。事实上,云计算数据存储当然可以帮助组织实现卓越的投资回报率。但是,通常在选择仅云(clo...

    hearaway 评论0 收藏0
  • #yyds干货盘点#安全管理制度管理办法范文

    摘要:第四章安全管理制度发布第十条安全管理制度必须以正式文件的形式发布施行。第十一条安全管理制度由信息安全管理小组制订,信息安全领导小组审批发布。第二十条安全管理制度的修改与废止须经信息安全领导组织审批确认,信息安全管理部门备案。 字数 3610阅读 760评论 0赞 3《xxxx安全管理制度汇编》****制度管理办法****文...

    duan199226 评论0 收藏0
  • 指南者stm32单片机keil5新建工程和组织目录的那些事

    32单片机固件库入门(当我们新建工程时…的各种配置和目录结构)–学习笔记 一,关于keil5内部的一系列配置 由于下述代码的存在 每次如果想要包含stm32f10x_conf.h 只需要包含#include stm32f10x.h语句,同时包含下述宏定义 #ifdef USE_STDPERIPH_DRIVER #include stm32f10x_conf.h#endif 该宏定义可以在IDE中...

    edagarli 评论0 收藏0

发表评论

0条评论

Miracle_lihb

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<