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

HelloWorld

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

运行上面程序如图所示

我们通过上面的程序开始分析并学习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文档首页如图

2、类说明区格局如下图

由于只有以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!");
   }
 }

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

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

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

赞 (0)

相关推荐

  • Java之JFrame输出Helloworld实例

    Java之JFrame输出Helloworld实例

    本文实例讲述了Java之JFrame输出Helloworld的方法.分享给大家供大家参考.具体如下: JAVA的GUI程序的基本思路是以JFrame为基础,它是屏幕上window的对象,能够最大化.最小化.关闭.Swing是一个用于开发Java应用程序用户界面的开发工具包.以抽象窗口工具包(AWT)为基础使跨平台应用程序可以使用任何可插拔的外观风格.Swing开发人员只用很少的代码就可以利用Swing丰富.灵活的功能和模块化组件来创建优雅的用户界面. 说白了,你只需要很少的代码,就能利用JAVA

  • Debian配置JDK1.7 与Linux Java Helloworld

    Debian配置JDK1.7 与Linux Java Helloworld

    其实JAVA的原生平台是Linux的,只是它可以跨平台运行而已.在Linux中甚至就有了原生的JDK,但是这些JDK难免不完整,因此最好自己配置一个JDK1,7,为以后的Tomcat,安卓等做好准备.下面以JDK1.7在Debian的配置为例子,讲解在Linux中如何配置JDK. 一.JDK1.7的下载与安装 1.首先,与在Windows配置JDK一样,打开Java的官网(点击打开链接)同意了协议之后,下载Linux版的JDK,下载那个压缩版的.tar.gz.记得同意协议,否则永远不让下载.I3

  • Java HelloWorld原理分析_动力节点Java学院整理

    我们初学java的第一个程序是"hello world" public class HelloWorld { public static void main(String[] args) { System.out.println("hello world"); } } 上面程序到底是怎么在屏幕上输出"hello world"的呢?这就是本来要讲解的内容,即System.out.println("hello world")的原理

  • java 学习笔记(入门篇)_java程序helloWorld

    java 学习笔记(入门篇)_java程序helloWorld

    安装配置完Java的jdk,下面就开始写第一个java程序--hello World.用来在控制台输出"Hello World".首先,我们用最原始的方法,即用文本编辑器来写代码.在任意一个盘符下,以D盘根目录为例,在这个目录下建立一个txt文本,命名为HelloWorld,然后把后缀改为java,即HelloWorld.java. 然后打开编辑代码,如下: 复制代码 代码如下: public class HelloWorld { public static void main(Str

  • Linux下Java开发环境搭建以及第一个HelloWorld

    想在Linux进行JAVA开发吗?环境如何搭建,第一个HelloWorld如何实现,下面马上奉献: 1环境搭建     1.1 Java JDK 的安装     Java JDK 是java编译和运行的必要环境,所以首先必须安装这一软件包,方法如下:     1)下载JDK压缩包,注意看好版本是x86还是x64,windows的还是           linux,要搞清楚,我下的是jdk-7u13-linux-i586.tar.gz:     2)解压压缩包,并将解压后的目录放到/usr/li

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

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

    HelloWorld public class HelloWorld { public static void main(String args[]) { System.out.println("Hello World!"); //向控制台输出一条语句,同时必须以;结尾 } } 运行上面程序如图所示 我们通过上面的程序开始分析并学习Java语言的基础知识: 1.注释: Java的注释分为三种:单行注释//  多行注释/*-*/  文档注释 像上面的HelloWorld程序分别用到了多行

  • Java程序中Doc文档注释示例教程

    Java程序中Doc文档注释示例教程

    目录 Doc注释规范 @符号的用处 如何生成Doc文档 第一个:Dos命令生成 第二个:IDE工具生成 许多人写代码时总不喜欢写注释,每个程序员如此,嘿嘿,我也一样 不过,话说回来,该写还是要写哦!没人会喜欢一个不写注释的程序员,当然,也没有一个喜欢写注释的程序员,今天,我们就来说说Java注释之一--Doc注释 我们知道,Java支持 3 种注释,分别是单行注释.多行注释和文档注释,我们来看看他们的样子 //单行注释   /* 多行注释 */   /** *@... *.... *文档注释 *

  • Java编程Iterator迭代器设计原理及实现代码示例

    我们知道迭代器(Iterator)是一种对象,它能够用来遍历标准模板库容器中的部分或全部元素.那么Iterator迭代器的设计原理是什么呢?迭代器问什么定义了一个借口,而不是一个类呢? 我们假设迭代器迭代数据的功能定义为了一个类,那么,会有这样的问题.不同的集合,由于数据结构不一样,所以他们的存储方式也是不一样的.也就是说,迭代器获取的时候,获取的方式是变化的,也就是不固定的.所以把这种方式定义为具体的实现是不合理的. 无论何种集合,他们肯定都有获取的功能,而且不知道什么时候就没有数据了.所有他

  • 入门java的第一步HelloWorld

    入门java的第一步HelloWorld

    踏过JDK开发环境安装这所大门,我们正式走进了Java的世界.Java是一门面向对象的编程语言,不仅吸收了c++语言的各种有点,还摒弃了c++里难以理解的多继承,指针等概念,因此它具有功能强大和简单易用两个特征,它的语法比c/c++都更加简单,它最大的优点就是可移植性很高,一次编写,到处执行,今天我们就来练习一下Java入行的第一段代码. public class HelloWorld { //HelloWorld叫做类名 public static void main(String[]args

  • Java的文档注释之生成帮助文档的实例

    Java的文档注释之生成帮助文档的实例

    示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * @author *** * @version 1.0 */ public class Person { /** * 这个是Person类的构造方法 * @param name Person 的名字 * */ public Person(String name) { //执行语句: } /** * 这是read

  • idea创建JAVA Class时自动生成头部文档注释的方法

    idea创建JAVA Class时自动生成头部文档注释的方法

    IDEA设置文档注释模板 创建Class文件时自动生成的头部注释如图 如何配置idea的头部注释格式,可以生成像之前的注释格式一样的文档注释? File->settings->Editor->File and Code Templates->Files->Class 原先模板 #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse(&

  • Java文档注释用法+JavaDoc的使用说明

    Java文档注释用法+JavaDoc的使用说明

    简介 文档注释负责描述类.接口.方法.构造器.成员属性.可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释. 注意:文档注释必须写在类.接口.方法.构造器.成员字段前面,写在其他位置无效. JavaDoc 官方说明 How to Write Doc Comments for the Javadoc Tool 写在类上面的JavaDoc 写在类上的文档标注一般分为三段: 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束 第

  • IntelliJ IDEA2022中的Java文档注释设置、操作方法

    IntelliJ IDEA2022中的Java文档注释设置、操作方法

    1.打开IDEA,点击setting-Editor-Live Templates. 2.点击右方的“+”准备进行文档注释的内容和快捷键设置. 右键,选中 change context,勾选中Java. 3.自定义文档注释模板,在Abbreviation中输入模块名称,在Description中输入描述,在Template text中输入注释内容. 自定义的注释内容依次是描述.作者.日期.参数. /** *@description: *@author:$USER$ *@date:$DATE$ $T

  • Python单元和文档测试实例详解

    本文实例讲述了Python单元和文档测试.分享给大家供大家参考,具体如下: 单元和文档测试 1.单元测试 单元测试就是用来对一个模块.一个函数或者一个类来进行正确性的检测工作. 1.若是单元测试通过,则证明测试的函数能够正确的工作, 2.反之则证明要么函数有bug要么输入不合法,总之我们需要修复我们的函数功能. 2.对函数进行单元测试 创建python文件MathFunc.py,内容如下: def mySum(x,y): return x + y def mySub(x,y) return x

  • 一篇文章带你入门Java之编程规范

    一篇文章带你入门Java之编程规范

    目录 引言 命名规则 代码排版 1.代码缩进对齐 2.遇到分号换行 3.大括号.括号等成对出现 4.加上注释 Java注释 注释的作用 注释的3种类型 给代码加上单行注释 给代码加上多行注释 给代码加上文档注释 总结 引言 ♀ 小AD:小明哥,之前你教我的Helloworld实例我写完了,超级简单呢,我一下子就搞定了 ♂ 明世隐:是吗,那不错哦. ♀ 小AD:我还举一反三.自由发挥了一波 ♂ 明世隐:这波怎么说? ♀ 小AD:怎么说?我说我在第5层,你信不 ♂ 明世隐:我信,你举的什么.反的什么

随机推荐