一、命名规范
1、 项目名全部小写
2、 包名全部小写
3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
如:
public class MyFirstClass{}
4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
如:
int num=0;
public void myMethod(){}
5、 常量名全部大写
如:
public static final String GAME_COLOR=”RED”;
6、所有命名规则必须遵循以下规则:
1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使用Java中的关键字。
4)、不允许出现中文及拼音命名。
二、注释规范
1、 类注释
在每个类前面必须加上类注释,注释模板如下:
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00
*/
2、 属性注释
在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */
private String strMsg = null;
3、 方法注释
在每个方法前面必须加上方法注释,注释模板如下:
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
4、 构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
5、 方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如://背景颜色
Color bgColor = Color.RED;
分享到:
相关推荐
本人觉得这对于从事程序开发的程序员很有必要的了解一下。 因为这是一下很基本的东西,不解释!
阿里巴巴Java开发命名规范
本项目的整体命名规范,在Java语言的命名规范的基础上,做出更符合这次项目开发的规定,
Java项目开发规范:MVC各模块的命名规范。
java 命名 项目 规范java 命名 项目 规范
在Java编程中,代码命名规范的重要性不容忽视。它不仅影响着代码的可读性和可维护性,还直接关系到项目的开发效率和团队协作的顺畅性。一个遵循良好命名规范的代码库,可以使开发者更快速地理解代码意图、减少错误、...
包命名规则: 1、 当项目比较大,分为Fee(财务),Plan(个人计划),……等N个模块时候,我们的包结构一般如下:
java、svn、mysql、dubbr、venus-common-monitor、venus-restful、公共码、日志、代码规范、命名、配置文件、Code+Review建议、postman等等等等;各类规范文档
很好的规范文档。
Code Review CheckList-Java java开发中 细节规范
一、前言 为规范技术部项目编码习惯,提高代码...(一)命名规范 1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 反例:_name / __name / $name / name_ / name$ / name__
NULL 博文链接:https://ice666-1.iteye.com/blog/2238579
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。下面给大家分享java开发命名规范,一起看看吧
SSH框架项目开发命名规范,包含各层包及类命名规范、配置文件命名规范、其它命名规范
好的命名规范可以让你的程序更专业,更容易被别人理解,更好维护,增加可读性,减少项目组中因为换人而带来的损失。任何一个软件,几乎都不是由最初的开发人员来维护,在软件的生命周期中,大部分的花费在于维护。...
命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)
代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。 代码编写规范使用范围:J2EE项目开发。
它包含了一系列关于程序命名、代码注释、代码格式、异常处理、安全性等方面的规范要求和最佳实践。阿里Java代码规范旨在提高代码的可读性、可维护性和稳定性,使得团队协作和代码维护更加高效和一致。 这些工具和...
Java Web应用开发规范。 为了使软件开发过程有章可循,保证软件质量,加强开发管理 开发管理 项目周期 命名规范