"Avatar Java编码规范:源文件基础及格式化(UTF-8)"
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编程中提供了清晰、统一的编码规范,有助于提高代码的可读性和可维护性,使团队成员能够更轻松地理解和协作。遵循这些规范可以帮助开发人员写出高质量、一致的代码,提高项目的质量和效率。
![](https://csdnimg.cn/release/download_crawler_static/16268238/bg5.jpg)
剩余23页未读,继续阅读
![](https://img-home.csdnimg.cn/images/20210720083646.png)
![docx](https://img-home.csdnimg.cn/images/20210720083331.png)
![docx](https://img-home.csdnimg.cn/images/20210720083331.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://profile-avatar.csdnimg.cn/1538e84a83444fe29a8075dfd8aea69a_qq_41469636.jpg!1)
- 粉丝: 153
- 资源: 3
我的内容管理 收起
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助
![](https://csdnimg.cn/release/wenkucmsfe/public/img/voice.245cc511.png)
会员权益专享
最新资源
- 京瓷TASKalfa系列维修手册:安全与操作指南
- 小波变换在视频压缩中的应用
- Microsoft OfficeXP详解:WordXP、ExcelXP和PowerPointXP
- 雀巢在线媒介投放策划:门户网站与广告效果分析
- 用友NC-V56供应链功能升级详解(84页)
- 计算机病毒与防御策略探索
- 企业网NAT技术实践:2022年部署互联网出口策略
- 软件测试面试必备:概念、原则与常见问题解析
- 2022年Windows IIS服务器内外网配置详解与Serv-U FTP服务器安装
- 中国联通:企业级ICT转型与创新实践
- C#图形图像编程深入解析:GDI+与多媒体应用
- Xilinx AXI Interconnect v2.1用户指南
- DIY编程电缆全攻略:接口类型与自制指南
- 电脑维护与硬盘数据恢复指南
- 计算机网络技术专业剖析:人才培养与改革
- 量化多因子指数增强策略:微观视角的实证分析
![](https://img-home.csdnimg.cn/images/20220527035711.png)
![](https://img-home.csdnimg.cn/images/20220527035111.png)
![](https://csdnimg.cn/release/wenkucmsfe/public/img/green-success.6a4acb44.png)