欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

从HelloWorld和文档注释开始入门Java编程

程序员文章站 2024-03-06 14:16:32
helloworld public class helloworld { public static void main(string args[])...

helloworld

public class helloworld
{
  public static void main(string args[])
  {
  system.out.println("hello world!");  //向控制台输出一条语句,同时必须以;结尾
  }   
}

运行上面程序如图所示

从HelloWorld和文档注释开始入门Java编程

我们通过上面的程序开始分析并学习java语言的基础知识;

1、注释:

      java的注释分为三种:单行注释//  多行注释/*…*/  文档注释

      像上面的helloworld程序分别用到了多行注释和单行注释。

       java还提供了另外一种注释叫文档注释,如果编写java源代码时添加了合适的文档注释,然后通过jdk提供的javadoc工具可以直接将源代码里的文档注释提取成一份系统的api文档。api文档就是用以说明应用程序接口的文档。对于java而言,api文档通常说细说明了每个类、每个方法的功能及用法。

       java语言的api文档的下载地址:http://www.oracle.com/technetwork/java/javase/downloads/index.html

   关于文档注释,我会在后面专门有一篇文章

2、java的组织形式

//java程序必须是以类class形式存丰,类class是java程序的最小程序单位
class 类名
{
 /*java解释器规定:如需某个类能被解释器直接解释执行,则这个类必须包含main方法,而且main方法必须使用pulbic static void来修饰,且main方法的形参必须是字符串数组类型(string args[]是字符串数组的形式) 也就是说main方法基本上固定不变的
*/
  public static void main(string args[]) 
 {
 
  }   
}

3、java源文件的命名规则
    1)java程序源文件的后缀必须是.java,不能是其他文件后缀名

    2)一个java源文件可以包含多个类定义,但最多只能包含一个public类定义;如果java源文件里包含public类定义,则该源文件的文件名必须与这个public类的类名相同

    3)java语言是严格区分大小写的语言。因为源文件的文件名保存的时候也应注意大小写

    4)java程序中的关键字全部是小写的

总结:通过上面的程序简单地说了一下java程序的框架结构。

文档注释

java语言提供了一种功能更强大的注释形式:文档注释。如果编写java源代码时添加了合适的文档注释,然后通过jdk提供的javadoc工具可以直接将源代码里的文档注释提取成一份系统的api文档。api是应用程序接口的意思,api是java提供的基本编程接口,当使用java语言进行编程时,不可能把所有的java类、所有方法全部记下来,那么如果我们遇到一个不确定的地方时,必须通过api文档来查看某个类、某个方法的功能和用法。

java api文档的下载地址:http://www.oracle.com/technetwork/java/javase/downloads/index.html

下载完成之后,打开docs/api文件夹里面的index.html文件,

1、api文档首页如图

从HelloWorld和文档注释开始入门Java编程

2、类说明区格局如下图

从HelloWorld和文档注释开始入门Java编程

从HelloWorld和文档注释开始入门Java编程

由于只有以public或protected修饰的内容才是希望暴露给别人使用的内容,而api文档主要是向使用者提供信息,因此javadoc工具默认只处理public或protected修饰的内容。如果开发者确实希望javadoc工具可以提取private修饰的内容,则可以在使用javadoc工具时增加-private选项来实现

下面我们通过一个演示程序来说明文档注释

package gee;
/**
 网站:<a href="http://www.geeit.me/">作者博客站</a>
 <br/>这是一个javadoc工具演示的程序
 <br/>程序名:javadoc演示程序
 <br/>程序文件名:javadocdemo
 @author gee
 @version 1.0
 */
 public class javadocdemo
 {
   /** 简单的测试field
   */
   protected string name;
   /** 主方法,程序的入口 */
   public static void main(string[] args)
   {
       system.out.println("hello world!");
   }
 }

从HelloWorld和文档注释开始入门Java编程

除此之外,如果我们希望 javadoc工具生成更详细的文档信息,例如为方法参数、方法返回值等生成详细的说明信息,则可利用javadoc标记。常用的javadoc标记如下。

  •   @author:指定程序的作者 
  •   @version:源文件的版本
  •   @deprecated:不推荐使用的方法
  •   @param:方法的参数说明信息
  •   @return:方法的返回值说明信息
  •   @see: “参见”用于指定交叉参考的内容
  •   @exception:抛出异常的类型
  •   @throws:抛出的异常,和exception同义。

javadoc工具默认不会提取@author和@version两个标记信息,如果需要提取这两个标记应该使用javadoc工具指定的-author和-version两个版本