当前位置：首页 > 资讯 > 技术文档

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

时间：2021-07-13 21:28 编辑：来源：阅读：
扫一扫，手机访问

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

[b]HelloWorld[/b]

public class HelloWorld
{
  public static void main(String args[])
  {
  System.out.println("Hello World!");  //向控制台输出一条语句，同时必须以;结尾
  }   
}

运行上面程序如图所示 [img]http://files.jb51.net/file_images/article/201510/2015102491959527.png?201592492013[/img] 我们通过上面的程序开始分析并学习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程序的框架结构。 [b]文档注释[/b] 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文档首页如图 [img]http://files.jb51.net/file_images/article/201510/2015102492033785.png?201592492042[/img] 2、类说明区格局如下图 [img]http://files.jb51.net/file_images/article/201510/2015102492055088.png?20159249215[/img] [img]http://files.jb51.net/file_images/article/201510/2015102492116807.png?201592492127[/img] 由于只有以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!");
   }
 }

[img]http://files.jb51.net/file_images/article/201510/2015102492140499.png?201592492149[/img] 除此之外，如果我们希望 javadoc工具生成更详细的文档信息，例如为方法参数、方法返回值等生成详细的说明信息，则可利用javadoc标记。常用的javadoc标记如下。 [list] [*] @author:指定程序的作者 [/*] [*] @version:源文件的版本[/*] [*] @deprecated:不推荐使用的方法[/*] [*] @param:方法的参数说明信息[/*] [*] @return:方法的返回值说明信息[/*] [*] @see: “参见”用于指定交叉参考的内容[/*] [*] @exception:抛出异常的类型[/*] [*] @throws:抛出的异常,和exception同义。[/*] [/list] javadoc工具默认不会提取@author和@version两个标记信息，如果需要提取这两个标记应该使用javadoc工具指定的-author和－version两个版本

全部评论(0)

上一篇：java简易文本分割器实现代码
下一篇：浅谈Java编程中的内存泄露情况

资讯排行榜
更多>>