代码注释的三种方式

最新推荐文章于 2024-04-24 21:00:50 发布
最新推荐文章于 2024-04-24 21:00:50 发布
阅读量1.9k 收藏
点赞数 1
分类专栏： Java基础 文章标签： java eclipse
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_47248941/article/details/119181590
版权

Java注释

对所写的程序进行解释说明

Java的三种注释方式

单行注释

//后面的内容为注释

多行注释

/*
其中内容为注释

*/
在java进行编译时单行注释与多行注释不被编译

文档注释(java特有)

格式：/**
@author 指定java程序的作者
@version 指定源文件的版本
*/
注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档(类似API文档)。
操作方式：

javadoc -d 新文件名 -aouhor -version 被编译文件名.java
lovel呀
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Doxygen代码注释规范.docx
07-15
Doxygen 代码注释规范 Doxygen 是一种开源跨平台的，以类似 JavaDoc 风格描述的文档系统，完全支持 C、C++、Java、Objective-C 和 IDL 语言，部分支持 PHP、C#。Doxygen 可以从一套归档源文件开始，生成 HTML 格式...
C#的XML两种代码注释实例说明
09-05
C#的XML注释是一种特殊形式的代码注释，它允许开发者在代码中添加结构化的文档，这些文档在编译时可以被转换成XML格式，方便生成API文档或其他技术文档。这种注释方式增强了代码的可读性和文档的生成效率。 在C#中...
Eclipse---设置代码模板（注释信息、作者信息）
魔芋小灰菜
05-12 1580
Eclipse—设置代码模板（注释信息） 路径：Window->Preferences->Java->Code Style->Code Templates 展开Code->New Java files ,此时在pattern中展示的模板便是在eclipse中新建 java类使用的模板 关于author的设置： 1.在Eclipse启动时加入启动参数或在eclipse.ini中 -vmargs 后面增加参数-Duser.name=sgl 2.直接修改@author
IDEA代码自动添加作者信息注释
最新发布
qq_43342391的博客
04-24 829
idea自动生成作者注释
php DOC类型注释的用法
weixin_30408739的博客
08-24 93
/** *@name名字 *@abstract申明变量/类/方法 *@access指明这个变量、类、函数/方法的存取权限 *@author函数作者的名字和邮箱地址 *@category组织packages *@copyright指明版权信息 *@const指明常量 *@deprecate指明不推荐或者是废弃的信息...
VS2013代码注释
01-05
除了内置功能外，VS2013还可以通过安装第三方插件进一步增强代码注释能力。例如，Resharper是一款流行的插件，它提供了更丰富的代码注释和文档生成选项，可以自动检测未注释的代码并提示用户添加。 6. **代码风格...
java代码注释模板
08-23
Java代码注释主要有三种类型： 1. 单行注释：以`//`开头，常用于临时性的或者快速的注解，例如： ```java // 这是一个示例单行注释，用于解释下面的代码功能 ``` 2. 多行注释：以`/*`开始，`*/`结束，可以跨越多行...
清理代码注释C#Winform源代码
08-05
在编程领域，代码注释是极其重要的，它们用于解释代码的功能、逻辑或目的，以便其他开发者能更快地理解和维护代码。然而，在某些情况下，如版本更新、代码重构或准备发布库时，可能需要移除这些注释以减少文档负担或...
Java代码、注释模版格式文件
04-12
Java代码、注释模版格式文件
【代码规范】常见注释规范
一蓑烟雨任平生
12-26 3209
1.在有处理逻辑的代码中，源程序有效注释量必须在20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 2.文件注释：文件注释写入文件头部。 说明：以/* 开始 示例： / * * 文件名：[文件名] * 作者：〈版权〉 * 描述：〈描述〉 * 修改人：〈修改人〉 * 修改时间：YYYY-MM-DD * 修改内容：〈修改内容〉 */ 说明：每次修改后在文件头部写明修改信息。 示例： / *
注释---＞一个编写代码不容忽视的技能
wei7a7a7a的博客
05-06 362
为了方便程序的阅读，Java语言允许程序员在程序中写上一些说明性的文字，用来提高程序的可读性，这些文字性的说明就称为注释。 注释不会出现在字节码文件中，即Java编译器编译时会跳过注释语句。 在Java中根据注释的功能不同，主要分为单行注释、多行注释和文档注释。 单行注释 单行注释使用“//”开头，“//”后面的单行内容均为注释。 多行注释 多行注释以“/*”开头以“*/”结尾，在“/*”和“*/”之间的内容为注释，我们也可以使用多行注释作为行内注释。但是在使用时要注意，多行注释不能嵌套使用。 文档.
Python代码注释详解（0基础入门
2301_80239908的博客
12-28 1970
代码注释就是给一段代码加上说明，表明这段代码的作用或者实现的功能，方便别人阅读代码。看看上面这个图，问题来了，那个女孩是谁？张三？李四？王五？除了上帝谁也不知道**（上帝：我也不知道）**！！加上注释再来一遍：禽兽，放开小红，我小明愿意和她交换。大家就都明白了，原来这个女孩叫小红，这个 Gay 叫小明。1.方便代码阅读2.被注释的代码，程序不会执行。
教你写好代码注释
热门推荐
ruanrunxue的博客
12-08 1万+
前言 相信大家都会遇到这种情况：一周前自己写的代码，现在再拿出来看，发现读不懂了，“ 这代码是我写的？？？”。这时候，代码注释就可以发挥它的作用了——提高晦涩难懂的代码的可读性；注释可以起到隐藏代码复杂细节的作用，比如接口注释可以帮助开发者在没有阅读代码的情况下快速了解该接口的功能和用法；如果写的好，注释还可以改善系统的设计。 既然注释这么多好处，为什么我们程序员还是不愿意写注释？ “代码都写不完...
代码中的注释撰写
weixin_42806281的博客
06-19 841
以注释撰写AF ，RI 选择某种特定的表示方式R，进而指定某个子集是“合法”的(RI)，并为该子集中的每个值做出“解释”(AF)——即如何映射到抽象空间中的值 即使是同样的R、同样的RI，也可能有不同的AF，即“解释不同”。 而在代码中撰写AF，RI时，其实时在代码规范上添加对应的想法（你设计这个ADT要干什么或是用户要求你干什么） public class Set{ private...
项目必备！永无 bug 注释
Star_Monkey的博客
07-13 1万+
如来佛代码注释，保佑代码无BUG /* _ooOoo_ o8888888o 88" . "88 (| -_- |) O\
python 代码注释
08-30
Python代码注释是在代码中添加解释和说明的文本，用于帮助开发人员理解代码的作用和功能。Python中有两种常见的注释方式： 1. 单行注释：使用"#"符号来添加注释，它会忽略该符号后面所有的内容。例如： ```python ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值