java标识符,关键字,注释及生成Doc文档
# java语法基础 |
---|
## 标识符,关键字与注释 |
### 标识符 |
1.类名,变量名,方法名都称为标识符。 |
2.命名规则:(1):所有的标识符都应该以字母(AZ,或者az)美元符($)或者下划线(_)开始. |
(2):首字符之后可以是任意字符的组合。 |
(3):关键字不能用作标识符。 |
(4):标识符的大小写是敏感的。 |
3.标识符样例 ![]() |
|
| |
| |
| |
| ## 关键字 |
| |
| 1.关键字是有特定意义的系统预定义保留的标识符。 |
| 2.java中常见的关键字 |
| |
| |
| ## 注释 |
| |
| 1.java中的注释分为(1):单行注释(2):多行注释(3):文档注释 |
| |
| (1)单行注释://注释内容 |
| |
| (2)多行注释:/* 注释内容 / |
| |
| (3)文档注释:/* |
| |
| *........(可以是标签) |
| |
| *........(可以是标签) |
| |
| *........(可以是标签) |
| |
| */ |
| |
| 2.java中常用的标签 |
| |
| | 标签 | 描述 | 示例 | |
| | -------- | ---------------- | ----------------- | |
| | @author | 标识一个类的作者 | @author name | |
| | @version | 指定使用类的版本 | @version 1.8 | |
| | @return | 返回值的类型 | @return void | |
| | @throws | 抛出异常 | @throws Exception | |
| |
| 3.代码示例 |
| |
| java | | package com.IT.operator.base; | | /** | | * @author sunjiabo | | * @version 1.0 | | * @since 1.8 | | */ | | public class Doc { | | String name; | | | | | | /** | | * @author sunjiabo | | * @param name | | * @return | | * @throws Exception | | */ | | public String test(String name) throws Exception{ | | return name; | | } | | } | |
|
| |
| 4.使用java.Doc生成文档 |
| |
| Javadoc命令是用来生成自己API文档的 。 |
| |
| 利用写好的文档注释-->选中当前的类找到在文件夹中打开(右键IDEA的自己写的类)-->(可以在命令行打开)此处使用在命令行打开-->在文件导航栏选中文件在目录前加cmd
空格打开-->打开后输入命令javadoc-encoding UTF-8 -charset UTF-8 doc.java(解决可能出现乱码,中文的问题) |
| 生成后打开生成的index.html即可。(可利用上面的代码生成java.doc) |
| |
| 5.生成java.Doc文档可见点击跳转到狂神说java |