找回密码
 立即注册
搜索
查看: 27|回复: 0

[闲聊] [Java教程] 3.2 Java 注释

[复制链接]

37

主题

2

回帖

417

积分
UID:
3
用户组:
社区总版
金钱:
189
点券:
0
名望:
0
贡献:
0
发表于 7 天前 | 显示全部楼层 |阅读模式
多敲多练才是有效学习编程的方式。
把你们敲的代码、整理的笔记回复到帖子中共同学习、讨论、进步


Java 注释

在计算机语言中,注释是计算机语言的一个重要组成部分,用于在源代码中解释代码的作用,可以增强程序的可读性,可维护性。
Java 注释是一种在 Java 程序中用于提供代码功能说明的文本。
注释不会被编译器包含在最终的可执行程序中,因此不会影响程序的运行。
注释是良好的编程习惯,它们帮助程序员更容易地理解代码的用途和功能,并且在团队协作中非常有用。
Java 注释主要有三种类型:

  • 单行注释
  • 多行注释
  • 文档注释




单行注释
单行注释以双斜杠 // 开始:

  1. // 这是一个单行注释
  2. int x = 10; // 初始化一个变量x为10
复制代码



多行注释
多行注释以 /*开始,以 */结束:

  1. /*
  2. 这是一个多行注释
  3. 可以用来注释多行代码
  4. */
  5. int y = 20; // 初始化一个变量y为20
复制代码



文档注释
文档注释以 /** 开始,以 */ 结束,通常出现在类、方法、字段等的声明前面,用于生成代码文档,这种注释可以被工具提取并生成 API 文档,如 JavaDoc。

  1. /**
  2. * 这是一个文档注释示例
  3. * 它通常包含有关类、方法或字段的详细信息
  4. */
  5. public class MyClass {
  6.     // 类的成员和方法
  7. }
复制代码
文档注释的格式通常包含一些特定的标签,如 @param 用于描述方法参数,@return 用于描述返回值,@throws 用于描述可能抛出的异常等等,这些标签有助于生成清晰的API文档,以便其他开发者能够更好地理解和使用你的代码。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

手机版|小黑屋|刹那综合社区

GMT+8, 2025-3-19 01:58 , Processed in 0.270896 second(s), 19 queries .

Powered by Discuz! X3.5

© 2001-2025 Discuz! Team.

快速回复 返回顶部 返回列表