|
Java 代码的基本知识
Java 私塾跟我学系列——JAVA 篇 网址:www.javass.cn
1:语句
用分号”;”结尾的一行代码就是语句,Java 中语句必须以”;”结尾。
如:int a = 10;
可以有块语句,例如:
int i=0;
{
int j = 0;
j = j+1;
}
i++;
2:块(block)
一个块是以{}作为边界的语句的集合,块可以嵌套。如:
{
int a = 10;
String s = ""; //一条语句或多条语句均可
{
System.out.println(“块可以嵌套”);
}
}
3:注释
什么是注释呢?就是标注解释的意思,主要用来对 Java 代码进行说明。Java 中有三种注释方式:
(1)//:注释单行语句
示例:
//定义一个值为 10 的 int 变量
int a = 10;
(2)/* */:多行注释
示例:
/*
这是一个注释,不会被 Java 用来运行
这是第二行注释,可以有任意多行
*/
(3)/** */:文档注释
紧放在变量、方法或类的声明之前的文档注释,表示该注释应该被放在自动生成的文档中(由 javadoc 命令生成的 HTML 文件)以当作对声明项的描述。
示例:
/**
*这是一个文档注释的测试
*它会通过 javadoc 生成标准的 java 接口文档
*/
常常在 javadoc 注释中加入一个以“@”开头的标记,结合 javadoc 指令的参数,可以在生成的 API 文档中产生特定的标记。
常用的 javadoc 标记
@author:作者
@version:版本
@deprecated:不推荐使用的方法
@param:方法的参数类型
@return:方法的返回类型
@see:参见,用于指定参考的内容
@exception:抛出的异常
@throws:抛出的异常,和 exception 同义
javadoc 标记的应用范围
在类和接口文档注释中的标记有@see @deprecated @author @version
在方法或者构造方法中的标记有:@see @deprecated @param @return @exception @throws
在属性文档注释中的标记@see @deprecated
4:空格
在一个 Java 程序中任何数量的空格都是允许的
5:Java 编程基本的编码约定
可能有些还没有学到,没有关系,先了解一下。
类──类名应该是名词,大小写可混用,但首字母应大写。例如:
class AccountBook
class ComplexVariable
接口──接口名大小写规则与类名相同。
interface Account
方法──方法名应该是动词,大小写可混用,但首字母应小写。在每个方法名内,大写字母将词分隔并限制使用下划线。例如:
balanceAccount( )
addComplex( )
变量──所有变量都可大小写混用,但首字符应小写。词由大写字母分隔,限制用下划线,限制使用美元符号($),因为这个字符对内部类有特殊的含义。
currentCustomer
变量应该代表一定的含义,通过它可传达给读者使用它的意图。尽量避免使用单个字符,除非是临时“即用即扔”的变量(例如,用 i, j, k 作为循环控制变量)
常量──全部大写并用下划线将词分隔。
HEAD_COUNT
MAXIMUM_SIZE
控制结构──当语句是控制结构的一部分时,即使是单个语句也应使用括号({})将语句封闭。例如:
if (condition){
do something
}else{
do something else
}
语句行──每行只写一个语句并使用四个缩进的空格使你的代码更易读。
注释──用注释来说明那些不明显的代码段落;对一般注释使用//分隔符, 而大段的代码可使用 /*…*/分隔符。使用/**…*/将注释形成文档,并输入给 javadoc 以生成 HTML 代码文档。
|
|