Java注释怎么写？

最新推荐文章于 2024-07-20 10:20:35 发布
最新推荐文章于 2024-07-20 10:20:35 发布
阅读量186 收藏
点赞数
分类专栏： java注解 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lucien_ma/article/details/106306240
版权

Java注释讲解

注释

  • 注释是给程序员看的，程序并不会去执行它，也不会报错

单行注释

//双斜杠后面的就是被注释掉的内容（注释这一行）

多行注释

/*这中间包括的都是注释，可以同时注释多行*/
/*
	我是注释
	我是注释
	我也是注释
*/

JavaDoc文档注释

/**
*这中间的就是文档注释
*写在类前面就是类的信息
*写在方法前面就是方法的信息
*
*/
eg:
/**
*@author 作者
*@version 版本号
*@since 指明需要最早使用的jdk版本
*@param 参数名
*@return 返回值情况
*@throws 异常抛出情况
*/
lucien_ma
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
8.3-写代码必须要写注释吗？（为什么现实中不写注释？）
Robert Zhang
07-19 4232
一、写代码要写注释 “写代码要写注释”自从学编程，这就话就伴随着你。可见注释的重要性。 注释的作用： 说明函数的功能 说明函数参数的意思 说明函数这样设计的原理（计算公式） 说明函数的使用场景 作者和日期 说明变量的作用 函数调用方法与注意事项 总之为了能让读这个函数的人明白这个函数的功能，可以注释各种各样的信息。而没有这些注释文字，就不太容易看懂函数的功能与调用用方法。没有注释的情况下，隔一段时间之后，自己也看懂的自己所写函数的功能了。因此，很多书籍、老师、领导、同事、包括你自己，都会告诉你“一定要写
Javadoc中eg和ie
u011552182的专栏
05-18 497
Javadoc中"e.g."和"i.e."的区别 在Javadoc注释中，经常遇到两个容易弄混淆的缩写：“i.e.”和“e.g.”。 （1）“e.g.”是拉丁语“exempli gratia”的缩写，表示“例如”，就是“for example”的意思； （2）“i.e.”是拉丁语“id est”的缩写，表示补充说明，就是“that is”的意思； （3）还有一个缩写也比较常用：“etc.”，它是拉丁语“et cetera”的缩写，表示“等等”，就是“and so on”的意思。 PS注意： “e.g.
java学习-文档注释/** */生成帮助文档
whatname123的博客
08-14 474
文档注释的写法：/**内容 */ 例子： package example8; /**文档注释 注释类*/ public class Demo { /**私有变量i */ private int i=10; /**main方法 */ public static void main(String[] args) { // TODO 自动生成的方法存根 Demo demo1 = new Demo(); System.out.println(demo1.getI()); demo1.setI
注释详解/* //
最新发布
2301_79188149的博客
07-20 348
在C语言中/**/不会被算法解读，会变成空格，所以不能将/**/写在字符中间，将注释放在//之后，这样的注释只能是单行，但是既可以放在行首，也可以放在行尾。双引号里的注释符号，会成为字符串的一部分，从而成为普通符号，失去注释作用。当然，VS中还有许多的快捷键，这里就不多说明了。3.不管是哪一种注释，都不能放在双引号里面。将注释放在/**/之间，内部可以分行。/*开始后遇到的第一个*/就算结束。取消注释： ctrl+k+u。注释： ctrl+k+c。/**/不支持嵌套注释。4.注释多行及快捷键。
JAVA命名规则及注释语句
weixin_72064371的博客
07-11 404
①，用户自定义标识符，我们定义标识符一般是用来命名常量、变量、方法和类等的名字，遵循见名知意 命名规则如下： 合法：helloFriend、$helloFriend、hello_Friend 不合法：7helloFriend eg:hello Friend、 eg: helloFriend+hello Java源文件的任何地方都可以加注释语句，方便我们阅读并理解程序......
常见的注释种类和用法
dandelionoooo的博客
06-19 3641
Java注释： //：行注释，单选注释。用于某行代码后面 /**/：块注释。//的升级版，用来注释多行代码，也可以写多行注释 /***/：javadoc注释。同上，但是能写入javadoc文档说明，用来生成HTML格式的代码报告，所以注释文档必须写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。 jsp注释： <!-- 注释内容 --...
java中 // /* */ /** */三种注释的区别
huo_wa的博客
05-18 4462
java中`// /* */ /** */`三种注释的区别： 1、`//` 单行注释； 2、`/* */` 多行注释； 3、`/** */` 多行注释；生成javadoc时，这样的注释会被生成标准的javaapi注释；在调用类或方法时会提示，提示内容就是你写的注释；
Java的注释
10-28
本文将详细介绍几种常见的Java注释方式及其用途，并通过实例展示如何设置Eclipse IDE中的注释模板，帮助开发者更好地管理和组织代码。 #### 一、Java注释概述 Java提供了三种类型的注释： 1. **单行注释（//）**：...
Eclipse Java注释模板.txt
07-09
### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中，良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑，还能方便其他开发者理解代码意图，从而提高整个团队的工作效率。Eclipse作为一款...
java注释模板
05-11
eclipse中java类注释模板，有需要的朋友可以参考使用。
Java注释规范
07-11
Java 注释规范是为了让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。该规范定义了 Java 项目中注释的规范和要求，包括注释的类型、注释的内容、注释的位置、注释的格式等...
C++ 基础入门 之 注释 ( // 和 /**/ )/变量 /常量 ( #define 和 const )/关键字/标识符(变量名)命名规则
仙魁XAN
10-27 2006
C++ 开发的一些知识整理，方便后期遇到类似的问题，能够及时查阅使用。本节介绍，如果有不足之处，欢迎指出，或者你有更好的方法，欢迎留言。
优秀的java程序员怎么写注释的
360linker
08-12 1万+
前言 今天我们来说说如何编写Java注释。使用过Java的同学都非常熟悉，Java中有: §单行注释// 这是单注释 §多行注释/*这是多行注释*/ §Javadoc注释/**这是javadoc注释*/ 其实这里面还有很多细节呢，下面我们一一来揭晓 在这里相信有许多想要学习Java的同学，大家可以关注小编公众号卓越新腾。 哪些地方需要添加注释 首先，我们需要确定一下，添加注释的...
Java中 /** */注释和 /* */注释 的区别
太匆匆
12-09 7715
/**......*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符  注释文档将用来生成HTML格式的代码报告，所以注释文  档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。 你再调用类和方法的时候会出现提示，内容就是你写的注释。就好像文档帮助一样。类似"字符串".toString()，鼠标放在toStri
MyEclispse的注释模板设置/** 注解 */
bellus
05-04 1095
设置注释模板的入口： Window->Preference->Java->Code Style->Code Template->Comments节点  里面的属性全部是/**   */的配置，不同字段代表对不同的属性和方法添加注解的生成模版。包括 Types类注解  、methods 方法注解、Fields 属性注解、Constructors 构造器注解、 Overriding Methods
Java注释——//、/* */、/* **/
Java学习
03-26 1550
Java注释的三种类型 1、单选注释：符号是：// 2、块注释： 符号是： /* */ 可以跨多行 3、javadoc注释： 符号是： /** */ 可以跨多行， 生成javadoc时，这样的注释会被生成标准的javaapi注释。 /** */注释的话，你在调用类和方法的时候会出现提示，内容就是你写的注释。 而/* */就没有了。/* */就是//的多行版 ———————————————— 版...
MySql--三种注释写法
热门推荐
Osborn的博客
11-02 11万+
MySql--三种注释写法 需要特别注意  --   这种注释后面要加一个空格 #DELETE FROM SeatInformation   /*DELETE FROM SeatInformation */ -- DELETE FROM SeatInformation
Java注释/*和/**的区别
雪落南城的博客
03-05 1万+
Java注释的三种类型 1、单选注释：符号是：// 2、块注释： 符号是： /* */ 可以跨多行 3、javadoc注释： 符号是： /** */ 可以跨多行， 生成javadoc时，这样的注释会被生成标准的javaapi注释。 /** */注释的话，你在调用类和方法的时候会出现提示，内容就是你写的注释。 而/* */就没有了。/* */就是//的多行版 ...
简单实现注释转换（/* */）→(//)
Mmmmmmmi
08-06 1349
这只是简单实现，将一个正确代码中的注释进行转换，如果代码里面有错误的话，可能会出现问题，比如出现了 /* 但是不出现 */ 如果这时候文件结束了，这样注释转换就会出错，所以转换前，应先保证注释的正确性。（以下情况均是在注释正确的情况下进行） 话不多说，进入正题。 先分析一波： 我们读取一个.c文件时，第一个可能读取到的字符可能有 / 、正常代码、和EOF(文件为空，直接为文件尾...
java类中每个field的注释怎么写？
07-11
在Java类中，可以使用JavaDoc注释来为每个field编写注释。通常，注释应该包含字段的描述、用途和可能的取值范围等信息。以下是一个示例： ```java /** * 这是一个示例字段的注释。 * 它用于存储用户的姓名。 */ private String name; ``` 在上面的示例中，注释以`/**`开头，以`*/`结尾。注释内容应该在多行注释中进行描述，并使用适当的格式和标记。可以使用`@param`标记来说明字段的含义，`@return`标记来说明字段的返回值类型（如果适用），以及其他自定义标记来提供更多信息。 请注意，注释是可选的，但良好的注释可以帮助其他开发人员更好地理解代码，并提高代码的可读性和可维护性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值