Java 03 | 代码风格 注释 Javadoc

代码风格与注释 努力保持代码可读性。良好的编码风格的一些最重要的特点是: 一致的风格(间距,变量命名,缩进风格等) 大小(线不太宽,源文件不要太长) 描述性命名(变量,函数,类),例如变量或函数名称为年份或getUserName而不是x或f。让代码本身提供可解读性。 避免重复的代码:若有两个重要的代码块及其相似,应该想办法合并。 适当的评论, 使其他读者也能轻松理解你的代码 行注释: //分隔符开头行被当做注释。 Block(又名多行注释)注释: /*, */ , 但我们更推荐javadoc形式的注释。 Javadoc Javadoc: / **,*/, 可以(但不总是)包含描述性标签。 借助javadoc工具可以生成HTML格式的API文档。 第一段是方法的描述。描述下面是不同的描述性标签, 比如参数 @param, 返回值 @return, 可能抛出的任何异常 @throws /** * @author 名字,邮箱<address @ example.com> * @version 1.6 版本 * @param * @return */ public class Test { // class body }

2016-12-21 · 1 min · Cong Chan

Java 02 | 语法基础

Java基本语法 public class HelloWorld { public static void main(String[] args) { System.out.println("Hello world!"); } } 上面的程序由一个类声明组成,该声明使用关键字public class声明。 Java所有的代码都应该包含在class里面。 真正负责运行的代码,是一个名为main的method,它声明为public static void main(String[] args)。 public:公共的,大部分方法都是以这个关键字开始的,后面会进一步解释。 static:这是一个静态方法,不与任何特定的实例关联,后面会解释。 void:它没有返回类型。 main:这是方法的名称。 String [] args:这是传递给main方法的参数。 使用大括号{ }来表示一段代码的开始和结束。 声明必须以分号结尾 静态分类 Static Typing 程序语言静态与动态的分类,可以参考oracle的说明文件,它解释了动态和静态类型之间的区别, 帮助你理解由程序的错误提示信息。 两个主要区别: 1. 动态类型语言在运行时执行类型检查,而静态类型语言在编译时执行类型检查。这意味如果以静态类型语言(如Java)编写的脚本包含错误,则在编译错误之前将无法编译. 而用动态类型语言编写的脚本可以编译,即使它们包含会阻止脚本正常运行(如果有的话)的错误。 2. 静态类型语言要求你在使用它们之前声明变量的数据类型,而动态类型语言则不需要。 考虑以下两个代码示例: // Java int num; num = 5; # Python num = 5 这两段代码都创建一个名为num的变量并赋值为5. 不同之处在于Java需要将num的数据类型明确定义为int。因为Java是静态类型的,因此它期望变量在被赋值之前被声明。 Python是动态类型的,不需要定义类型, Python根据变量的值确定其数据类型。动态类型语言更加灵活,在编写脚本时可以节省时间和空间。但是,这可能会导致运行时出现问题。例如: # python number = 5 numbr = (number + 15) / 2 #注意错字 上面的代码本应创建一个值为5的可变数字,然后将其加上15并除以2以得到10. 但是,number 在第二行的开头拼写错误。由于Python不需要声明变量,因此会不由分说直接创建一个名为numbr的新变量,并把本应分配给number的值分配给它。这段代码会很顺利编译,但是如果程序试图用number来做某事,程序员假设它的值是10,那么后续就无法产生期望的结果,而且还很难注意到问题。 ...

2016-12-20 · 1 min · Cong Chan

Java 01 | 安装

Hello World 参考了伯克利 Josh Hug 的 cs61b spring 2017 和 cs61b spring 2018. Lab, homework 和 project 代码实现参考 https://github.com/ShootingSpace/cs61b-data-structures. Java安装与配置 安装Java,前往Oracle下载java sdk,我用的是Java SE 8u151/ 8u152 版本。安装sdk时会同时安装sdr。 Windows系统配置: 推荐安装git bash, 一切按照默认安装就好. 更新系统环境变量: 直接在运行中搜索Environment Variables, 选择编辑系统环境变量, 在弹出的框中选择高级->环境变量, 在弹出的框中系统变量里面 新建变量: 变量名 = JAVA_HOME, 变量值 = 你的jdk路径,如C:\Program Files\Java\jdk1.8.0_151 编辑Path: 在前面加入%JAVA_HOME%\bin;%PYTHON_HOME%;(请注意,不能有空格.) OS X系统配置: 安装Homebrew,一个非常好用的包管理工具。要安装,请在terminal终端输入ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"(注意:在此过程中,可能会提示输入密码。当输入密码时,终端上不会显示任何内容,但计算机还是会记录你的密码的。这是一个安全措施, 让其他人在屏幕上看不到你的密码。只需输入您的密码,然后按回车。) 然后,通过输入以下命令来检查brew系统是否正常工作brew doctor. 如果遇到警告,要求下载命令行工具,则需要执行此操作。请参考这个StackOverflow。 安装git:输入brew install git 安装并配置好java后,测试是否成功: 随便在你喜欢的文件夹里新建一个java文件HelloWorld.java public class HelloWorld { public static void main(String[] args) { System.out.println("Hello world!"); } } 你可以选择用sublime来快速新建文件, 直接在你选择的文件里右键 git bash, 在git bash 里面键入subl HelloWorld.java, 还自动启动sublime并新建一个空白的HelloWorld.java文件, 把上面的代码复制进去并保存即可. (若出现类似提示: 找不到subl command, 解决办法请参考博文在Gitbash中直接启动sublime或atom等编辑器以打开或新建文件 ) 开始真正的测试。直接在之前打开的git bash中输入: ...

2016-12-18 · 1 min · Cong Chan