`
javafenger
  • 浏览: 246659 次
  • 来自: ...
文章分类
社区版块
存档分类
最新评论

java程序注释

阅读更多
     Java程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C++中见过的,使用/*...*/和//界定的注释。文档注释(被称为"doc comments")是Java独有的,由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。
    实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范,用来给出代码的总括,并提供代码自身没有提供的附加信息。
    程序可有4种实现注释的风格:块(block)--块注释通常用于提供对文件,方法,数据结构和算法的描述;单行(single-line)--短注释可以显示在一行内,并与其后的代码具有一样的缩进层级;尾端(trailing)--极短的注释可以与它们所要描述的代码位于同一行;行末(end-of-line)--注释界定符"//",可注释掉整行或一行中的一部分
    文档注释描述Java的类、接口、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类、接口或成员,位于声明之前。
    更多有关文档注释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html
 

分享到:
评论

相关推荐

    java的注释规范(单行注释、多行注释、分块注释)

    java 注释规范详解 java 注释规范是 Java 开发过程中不可或缺的一部分,它的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。java 注释规范可以分为三种:单行注释...

    Java代码注释率检查器.rar

    Java代码注释是编程实践中非常重要的一个环节,它有助于提高代码的可读性和维护性。注释能够解释代码的功能、用途以及实现逻辑,使得其他开发者能更快地理解代码,尤其在团队协作中更是不可或缺。本资源"Java代码...

    java文件注释清除工具

    能良好的解决使用jd-gui.exe软件反编译程序后,在生成的java文件前部存在的注释: 1.仅支持删除java文件和txt文件;(如果想支持其他格式的文件,请用"."+格式后缀名替换clear_annot类的103行".txt"); 2.仅支持删除...

    Java程序设计案例包含注释

    本压缩包中的"Java程序设计案例包含注释"是学习Java编程的重要资源,它涵盖了Java的基础知识,包括基本语法、面向对象概念、字符串处理以及异常处理等方面。下面将对这些知识点进行详细的阐述。 1. **Java基本语法*...

    JAVA编程笔记

    Java程序注释 - **单行注释**:使用 `//` 来创建单行注释。 - **多行注释**:使用 `/* ... */` 来创建多行注释。 - **文档注释**:使用 `/** ... */` 来创建文档注释,常用于生成 API 文档。 #### 9. Java编码...

    带注释的Java聊天程序 课程设计

    在本课程设计中,我们将深入探讨一个基于Java的聊天程序,该程序带有详细的注释,旨在帮助学习者理解和掌握Java编程以及网络通信的基本原理。这个项目不仅提供了源代码,还通过注释为初学者提供了宝贵的指导,使其...

    JAVA 去除注释的jar工具

    - **保留代码逻辑**:去除注释时,必须保证不改变原有代码逻辑,否则可能影响程序的正常运行。 - **备份源码**:在处理前最好备份源代码,以防万一需要回溯或参考注释内容。 - **版本控制**:如果项目使用了版本控制...

    java经典去注释程序

    本项目名为“java经典去注释程序”,专门针对Java代码中的三种主要注释类型——行内注释(//)、块注释(/* */)和Javadoc注释(/** */)进行清除。 这个程序采用了枚举(enum)数据类型,这是Java中一种特殊的数据...

    java注释规范文档

    Java作为一种广泛使用的编程语言,在其设计之初就充分考虑到了程序文档的重要性。本文将详细介绍Java注释的规范,尤其是javadoc这一强大工具的使用方法。 #### 二、Java注释概述 在Java中,注释主要有以下几种类型...

    JAVA基础入门PPT

    8. **Java程序注释**: - **多行注释**: ```java /* * HelloAccp.java * 2007-5-8 * 第一个Java程序 */ ``` #### 四、总结 通过本PPT的学习,Java初学者可以理解以下几点: - 什么是程序以及计算机中的程序...

    Java程序的注释.pdf

    Java程序的注释是编程实践中不可或缺的部分,它们有助于提高代码的可读性和维护性。Java提供了三种主要的注释方式,分别是单行注释、多行注释和文档注释。 1. **单行注释**: 单行注释是最常用的注释方式,通常用于...

    java5.0注释详解

    以上就是Java 5.0中关于注释以及其他相关特性的详细解释,这些改进不仅提高了代码的可读性和维护性,也增强了Java作为企业级开发语言的能力。对于开发者来说,理解并熟练掌握这些特性是非常重要的,因为它们已经成为...

    JAVA编程规则总结

    1. **Java程序注释规则** - **注释形式统一** 应在所有应用程序中使用一致的注释风格,包括标点符号和结构。即使其他项目的注释风格不同,也应遵循统一的标准。 - **注释内容准确简洁** 注释内容应简洁明了...

    JAVA自定义注释类及使用

    对某个类或某个方法进行注释,并且可以通过程序读取该注释来获取方法的用途或描述等。下面给出自定义注释的例子

    教学java教程

    #### 五、Java程序注释 - **单行注释**:以`//`开始,直到行尾结束。 - **多行注释**:以`/*`开始,以`*/`结束。多行注释可以在每行开头添加星号(`*`)来提高代码可读性。 - **文档注释**:以`/**`开始,以`*/`结束。...

    课程设计java程序源代码

    【Java程序源代码详解】 Java是一种广泛使用的面向对象的编程语言,由Sun Microsystems(现为Oracle Corporation的一部分)于1995年推出。它的设计理念是“一次编写,到处运行”,这意味着编写好的Java程序可以在...

    2022年 山大网络 期末考试 《JAVA程序设计》ABC卷模拟及答案,最全!

    "JAVA程序设计知识点总结" 本资源摘要信息涵盖了JAVA程序设计的多个方面,包括Java语法、对象oriented programming、异常处理、多线程、事件处理等。 一、Java语法 1. Java源代码中定义的类在编译后将生成对应的....

    第一个Java程序HelloWorld

    在本节中,我们将对 Java 语言的基本概念和语法进行总结,包括 Java 程序的基本结构、类和对象、变量、数据类型、运算符、控制流语句、方法和注释等。 类和对象 在 Java 中,类是对象的蓝图或模板,用于定义对象的...

    原程序注释

    给定 C/C++ 源程序的源代码,要求去掉所有的注释代码并输出去除注释后的代码。已知 C/C++ 代码的注释有两种:单行注释和多行注释,前者稳以“ // ”引导的行;后者则是由“ /* ”和“ */ ”包含的部分,可以在同一...

Global site tag (gtag.js) - Google Analytics