"Avatar Java编码规范:源文件基础及格式化(UTF-8)"
需积分: 10 174 浏览量
更新于2023-12-21
收藏 1.26MB DOCX 举报
Avatar Java Style Guide是Avatar公司在使用Java™编程语言编写代码时的完整规范定义。它不仅包括代码格式的问题,还涵盖了其他类型的公约和编码风格。然而,它更专注于硬性规则,避免提供建议。文件中的示例代码是非规范性的,意思是代码格式应该是可选的,并不应该将示例视为唯一的风格规则,而是要展示出Avatar设计的代码风格。
在源文件基础部分,源码文件名应该包含其最上层级类别,区分大小写,并加上扩展名.java。例如:File encoding UTF-8,源码文件的编码格式应该使用UTF-8。
3. File structure
3.1. Package statement
每个源文件都应该有一个包语句,并排在注释和其他语句之前。包语句应该是唯一的,所有的源文件都应该是相对于一个唯一的包名。
3.2. Import statements
import语句应该放在包语句下面,且位于注释之上。每个import语句应该是唯一的,不应该使用通配符(import xxx.*)。
4. Formatting
4.1. Braces
括号应该遵循下列样式:
if (condition) {
body of if
} else {
body of else
}
4.2. Indentation
使用四个空格作为一个缩进级别。不要使用制表符。
4.3. Line length
每行的长度不应超过100个字符。
4.4. Blank lines
在类的成员之间使用一个空行来分隔,使代码更易于阅读和理解。
4.5. Whitespace
在操作符(如=,+,-,*,/)前后使用空格,增加代码的可读性。
5. Naming
5.1. Package names
包名应全部使用小写字母。
5.2. Class names
类名应该使用大写字母开头的驼峰式命名法。
5.3. Method names
方法名应该使用小写字母开头的驼峰式命名法。
5.4. Constant names
常量名应全部使用大写字母,并使用下划线分隔单词。
6. Comments
6.1. Implementation comments
在代码中,应该使用适当的注释来解释代码的意图和实现。注释应该清晰、简洁,能够帮助他人理解代码。
6.2. Javadoc comments
对于公共的和受保护的类、方法、域,应该使用Javadoc注释来描述其功能和用法。这些注释应该包括描述、作者、版本等信息。
7. Programming practices
7.1. Avoid using wildcard imports
避免使用通配符导入,应该明确列出需要的导入。
7.2. Avoid using deprecated APIs
避免使用过时的API,尽量遵循最新的API规范。
8. Error handling
8.1. Handle exceptions appropriately
对于可能抛出异常的代码块,应该适当地处理异常,而不是简单地忽略或抛出。
总之,Avatar Java Style Guide为Avatar在Java编程中提供了清晰、统一的编码规范,有助于提高代码的可读性和可维护性,使团队成员能够更轻松地理解和协作。遵循这些规范可以帮助开发人员写出高质量、一致的代码,提高项目的质量和效率。
2022-05-09 上传
2022-11-12 上传
2020-04-06 上传
2024-06-17 上传
2019-07-04 上传
2022-06-19 上传
2021-10-06 上传
牛奶味的辣椒水
- 粉丝: 156
- 资源: 3
最新资源
- 构建基于Django和Stripe的SaaS应用教程
- Symfony2框架打造的RESTful问答系统icare-server
- 蓝桥杯Python试题解析与答案题库
- Go语言实现NWA到WAV文件格式转换工具
- 基于Django的医患管理系统应用
- Jenkins工作流插件开发指南:支持Workflow Python模块
- Java红酒网站项目源码解析与系统开源介绍
- Underworld Exporter资产定义文件详解
- Java版Crash Bandicoot资源库:逆向工程与源码分享
- Spring Boot Starter 自动IP计数功能实现指南
- 我的世界牛顿物理学模组深入解析
- STM32单片机工程创建详解与模板应用
- GDG堪萨斯城代码实验室:离子与火力基地示例应用
- Android Capstone项目:实现Potlatch服务器与OAuth2.0认证
- Cbit类:简化计算封装与异步任务处理
- Java8兼容的FullContact API Java客户端库介绍