Java注释与规范、javadoc命令生成帮助手册

来源:互联网 发布:淘宝企业店铺审核时间 编辑:程序博客网 时间:2024/06/05 02:03
1.查看Eclipse中自动编译出来的.class文件:
导航器--类似于Windows中的资源管理器
选择菜单“Window → Show View → Navigator” 项目名称下---bin目录
2.注释---是写给人(程序员)看的,对程序运行没有影响的代码。
A.单行注释:// 单行注释以 // 开始,例如:
// 输出信息到控制台
System.out.println("Hello World!!!");
B.多行注释:/* ... */ 多行注释以/*开头,以*/结尾 ,例如:
/*
* 这是一个多行注释
* 这是Java程序运行的入口
*/
public static void main(String[] args) {
// 输出信息到控制台
System.out.println("Hello World!!!");
}
C.文档注释:/** ... */ 以/**开头,以*/结束 主要用于生成帮助文档或手册 例如:
package com.ddb.javacore.helloworld;
/**
* 作者:ddb
* 时间:2017.03.17
* 说明:这是我的第一个java程序--HelloWorld
*/
public class HelloWorld {...}
说明:为了我们写的代码容易被看懂,强烈建议养成代码写注释的好习惯
3.Java编码规范
A.包名:全小写
B.文件名与类名一致
C.一个Java源码文件正常只包含一个public修饰的类
D.类名:每个单词的首字母都大写,驼峰式命名
E.变量:第一个单词的首字母小写,后面每个单词的首字母大写
F.方法:与变量命名规则一致
G.一行只写一条语句,并以;结尾
H.所有名称的命名,尽力做到见名之意!

4.javadoc命令生成帮助文档index开头的文件,通常都是首页文件
1.使用CMD提取文档注释的方式:

2.使用Eclipse提取文档注释的方式:
3.使用EditPluse提取文档注释的方式:-encoding UTF-8 -charset UTF-8 $(FileName)

其他知识:
1.Eclipse 中代码进行格式化快捷键:Ctrl+Shift+F;
2.在Eclipse的代码区中右键--show in --System explorer 可以打开当前编辑的源码文件在操作系统中的目录的位置;
3.【Ctrl++】、【Ctrl + -】放大和缩小当前正在编辑文件的字体大小;
4.【Ctrl+d】删除当前光标所在行;
5.关闭操作系统中服务,让系统更流畅:以MySQL为例
计算机---右键---管理--服务和应用程序--服务--找到MYSQL57--右键属性--启动类型--手动,同时停止服务!

1 0