java基础知识——注释

    技术2022-08-01  81

    1、注释

    1.1注释概述

    ● 注释是指在程序指定位置添加的说明信息 ● 注释不参与程序运行,仅仅起到说明的作用

    1.2注释的分类

    ● 单行注释 格式: //注释信息

    ● 多行注释 格式:/ * 注释信息 * /

    ● 文档注释 格式:/**注释信息 */ 说明:文档注释可以说是为了便于javadoc程序自动生成一个HTML文档

    javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。 也就是说,只要在程序编写完成后,通过javadoc就可以同时形成程序的开发文档了

    特别说明: (1)javadoc针对public类生成注释文档 (2)javadoc只能在public、protected修饰的方法或者属性之上注释 (3)javadoc注释的格式化:前导*号和HTML标签 (4)javadoc注释紧靠在类、属性、方法之前

    HTML的英文全称是 Hyper Text Markup Language,它被称为超文本标记语言,它包括一系列标签,通过这些标签可以将网络上的文档格式统一,是分散的internet资源链接为一个逻辑整体。HTML作文本室友HTML命令组成的描述性文本,HTML命令可以说明文字、图形、动画、声音、表格、连接等。

    常用的javadoc标记

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