代码结构-软件包-导入语句-注释

【摘要】写了好多代码，用过很多框架后，还记得一个.java文件的构成吗？本文用来快速回顾一个.java文件的组成部分。

前言

对编程了解越多，才懂得编程是个汪洋大海，自己所知道的那点东西只不过是一滴水。只想通过回顾基础，更加深入的理解Java这门语言、编程这件事。

代码结构

• 基本代码结构

  public class 类名{
  
  	public static void main(String[] args)
  	{
  		//代码块
  	}
  }

软件包[package]

• 语法：

  package 包名;
  //包名就是由字母、数字、_，不以数字开头的字符字符序列。
  //多级包名之间使用.隔开，如：
  package java.lang;
  package a.b.c.d.e.f.g;//ok

• 命名规则：

  A)、一般以公司域名为前半部分，如：`com.ali.xx.xx.xx;`		`com.aiz.xx.xx;`
  B)、以项目名和功能划分为后半部分，如：`com.ali.crm.servive;`		`com.aiz.se.day01;`

• 包的作用；
  包名在编译完成后生产的字节码中，会有对应的目录结构。
  所以，它可以很好地管理源文件和字节码。
  她还扩展了类的命名空间。
  如：有一个类都叫:Date
  那我们可以把它存放在不同的包中，如:
  java.util.Date;
java.sql.Date;
  这两个类的名字[简名]虽然不一样，但是处在不同的包中，是可行的。
  他们的全限定名是不一样的，因为全限定名是 包名.类名。

导入语句[import]

• 语法：

  import 包名.类名|*;

• 支持通配，只能通配类名，不能通配包名。
• 可以写多次。
• 何时需要使用导入语句？
  当一个类中需要使用非本包中的其他类时，则需要使用导入语句。
  除非目标类是在java.lang下

注释[commets]

• 是为了增加代码的可读性、理解性的一种手段，JVM的编译器是会忽略他的。

• Java语言支持三种注释：

  A、单行注释，以//开头
  B、多行注释，以/*开头，以*/结尾
  C、文档多行注释，以/**开头，以**/结尾
  	如：
  	/**
  	*XXXX
  	*XXXX
  	*XXXX
  	*/
  这种注释，将来可以通过javadoc命令来提取

• Eclipse设置注释模板：
  Window->Preferences->Code Templates->Comments。选择Files设置文件注释模板。可自定义。

  /**
  *
  */

• 选择Types设置作者、版本等信息。

  /**
  *@author &{user}
  *@version 1.0
  *@CreateDate ${date} ${time}
  *
  *${tags} 本类${file_name}的描述：
  */

  Window->Preferences->Code Templates->Code设置代码模板。

• IDEA设置注释模板：

• 类头注释
  打开File->setting->Editor->File and Code Templates->Includes->File Header。

  /**
   * @ClassName ${NAME}
   * @Description TODO
   * @Author ${USER}
   * @Date Create in ${TIME} ${DATE}
   * @Version 1.0
   */

• 方法注释
  File->setting->Editor->LiveTemplates 点击右边上面那个的+号，选择Template Group双击，然后弹出一个窗口，随便添加一个名字，我这里添加的是ZYGroup然后点击OK。(缺少截图，我知道)

  /**
   * @Author $USER$
   * @Description $DESCRIPTION$
   * @Date Create in $TIME$ $DATE$
   * @Param $PARAM$
   * @Return $RETURN$
   */

  找到关于设置注释模板笔记好的文章,等我有空就把他的文章抄过来。

结束语