小白Java笔记—

前言：Java语言是强类型的语言，包括两个含义：1.所有的变量必须先声明后使用；2.指定类型的变量只能接受类型与之匹配的值。
一、注释
（一）单行注释：使用//;
（二）多行注释：使用/* */;

public class CommentTest
{public static void main(String[] args){/*这是多行注释Java语言很有意思*/System.out.println("Hello World ");//System.out.println("这一行不显示出来")；
}
}

（三）文档注释
Java代码中添加了合适的文档注释，然后JDK提供的javadoc将文档注释提取成一种API文档。
API：应用程序接口。开发大型的软件时，通常会由很多人开发很多个类，为了使其他人可以容易的使用这些类，就用API文档说明这些类的具体功能，而不用知道这些类是怎么实现的。总得来说就是它详细说明了每个类、每个方法的功能及用法。
当然，javadoc文档只默认处理由public和protected修饰的类、方法、接口、成员变量、构造器和内部类的文档注释。
生成API文档操作：
1.编写一个Javadoc类：

package feng;
/**
*Description:
*<br>网站：<a href="www.baidu.com">小白Java系列均来自疯狂Java讲义</a>
*<br>Copyright (C) 2017-2017, Lunatic_fei
*<br>This program is protected by copyright laws.
*<br>Program Name:
*<br>Date:
*@author Lunatic_fei 1234@136.com
*@version 1.0
*/
public class JavadocTest{/**
*简单测试成员变量
*/
protected String name;
/**
*主方法，程序的入口
*@param args 这是调用函数
*/public static void main(String[] args){System.out.println("Hello World!");
}}

2.编写一个Test类

package kuang;
/**
*Description:
*<br>网站：<a href="www.baidu.com">小白Java系列均来自疯狂Java讲义</a>
*<br>Copyright (C) 2017-2017, Lunatic_fei
*<br>This program is protected by copyright laws.
*<br>Program Name:
*<br>Date:
*@author Lunatic_fei 1234@136.com
*@version 1.0
*/
public class Test{/***简单测试成员变量*/public int age;/***Test 类的测试构造器*/public Test(){}
}

使用cmd命令：javadoc -d apidoc -windowtitle 测试 -doctitle 学习生成API文档 -header 我的类 *Test.java 说明：其中*Test.java使用的通配符“ * ”意思是找到所有名字有XXTest.java的源文件（所以如果是Test1.java就不可以）。 **出现的错误：** 1. 错误: 编码GBK的不可映射字符解决问题：编辑时，我是用的是subline,并没有进行对其配置,导致编码类型不匹配，所以为了方便，直接重新用的记事本一遍，问题解决； 2.错误: 需要class, interface或enum 解决问题：出现的一个非常低级的问题，在写Test类时，写成了public Test｛｝
`，正确的是public class Test｛｝，特别写出来，以后不会再犯；
3.错误: 未知标记: auther
* @auther Lunatic_fei 123456@136.com
^
解决问题：同样是一个低级问题：作者author拼写错误，相信以后不会再写错了；
4. 警告: args没有 @param
解决问题：查了一下百度，只要在主函数上加一行*@param args，即可。即使不加也可以生成API文档。

使用包结构存放的方法：

javadoc -d apidoc  -windowtitle 测试 -doctitle 学习 -header 我的类 -version -author feng lee

小白Java笔记——注释相关推荐

小白自学笔记——JAVA基础 1.4注释
本章使用editplus编写. Java的注释分为3种单行注释多行注释文档注释(JAVA特有) 单行注释和多行注释的作用: 对所写的程序进行解释说明,增强可读性. 调试所写的代码特点单行注释 ...
JAVA笔记（1）Java概述、开发环境搭建、Eclipse概述、注释、关键字、常量、变量、数据类型、标识符
文章目录第1章 Java概述 1.1 Java语言发展史 1.2 跨平台原理 1.3 JVM JRE JDK 第2章 Eclipse开发工具 2.1 Eclipse概述和安装 2.2 Eclipse ...
4.8-全栈Java笔记:包机制
包机制是java中管理类的重要手段. 开发中,我们会遇到大量同名的类,通过包我们很容易对解决类重名的问题,也可以实现对类的有效管理. 包对于类,相当于,文件夹对于文件的作用. package 我们通过 ...
11.3-全栈Java笔记:线程的生命周期
一个线程对象在它的生命周期内,需要经历5个状态. 新生状态(New) 用new关键字建立一个线程对象后,该线程对象就处于新生状态.处于新生状态的线程有自己的内存空间,通过调用start方法进入就绪状态 ...
10.4-全栈Java笔记:常用流详解（二）
上节我们讲到「Java中常用流:文件字节流和字节数组流」,本节我们继续走起~ 缓冲流 BufferedInputStream和BufferedOutputStream这两个流是处理流,通过内部缓存数 ...
9.1-全栈Java笔记: 容器泛型—认识Collection接口
开发和学习中需要时刻和数据打交道,如果组织这些数据是我们编程中重要的内容. 我们一般通过"容器"来容纳和管理数据. 事实上,数组就是一种容器,可以在其中放置对象或基本类型数据. ...
Flux架构小白入门笔记
Flux架构小白入门笔记 Flux是facebook提出的一种处理前端数据的架构,学习Flux就是学习它的思想. 这个笔记是我在学习了阮一峰老师的Flux 架构入门教程之后得出, 里面的例子和部分原文 ...
10.6-全栈Java笔记:常见流详解（四）
上节我们讲到「Java中常用流:数据流和对象流」,本节我们学习文件字符流和文件缓冲流~ 文件字符流前面介绍的文件字节流可以处理所有的文件,但是字节流不能很好的处理Unicode字符,经常会出现&qu ...
10.8-全栈Java笔记:序列化/反序列化的步骤和实例
本节我们详细讲解10.3节中提到的序列化和反序列化操作. 序列化和反序列化是什么当两个进程远程通信时,彼此可以发送各种类型的数据. 无论是何种类型的数据,都会以二进制序列的形式在网络上传送.比如,我 ...

小白Java笔记——注释

小白Java笔记——注释相关推荐

最新文章

热门文章