补充：java如何对包进行注释？

最新推荐文章于 2024-04-30 10:42:39 发布
最新推荐文章于 2024-04-30 10:42:39 发布
阅读量1k 收藏 1
点赞数
分类专栏： 笔记 文章标签： java 开发语言 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yaoguaiba579567/article/details/121725108
版权

补充：如何对包进行注释？
需要将.java文件(注意是.java文件而不是.class文件)按照包名（多层就按照层次放好）分门别类的放在根据包名结构构建好的目录下，并在每个包（和.java文件放在一起）中添加一个package.html文件
文件的内容中，有用处的就是body，所以最简单的一个package.html文件如下

<body>
person包描述AFADFADF打单发
</body>

然后在包名文件夹所处的文件夹下（如果是多层，就在最顶层包名文件夹所在的文件夹内执行javadoc，例如crawling.app, java->crawling->app,那么就在java这一级执行javadoc），javadoc -d apidoc -author -version 包名
就能够输出包名注释，注意需要把html文件的编码变为在这里插入图片描述
否则会乱码。
还有需要注意的是，javadoc生成的网页和书上的有一定区别，应该是修改了。界面显示如下：
在这里插入图片描述
在这里插入图片描述

java注解jar包
10-10
注解一直是java的重难点，学会使用它将带来很多优越之处，这里提供了关于注解的jar包，很全面，供大家下载使用。
JAVA实验对源代码进行注释
11-19
在"JAVA实验对源代码进行注释"这个主题中，我们将深入探讨如何有效地使用Java中的不同注释类型，以及它们在软件开发过程中的重要性。 1. 单行注释： Java提供了一种简单的方式来进行单行注释，即使用两个斜线（//...
java包注释
weixin_43972159的博客
07-12 233
java包注释 需求 经常有这样的需求,对java的包,添加一个注释,描述一下这个包是干什么的 对策 源码 /** * Implementation package for {@code java.util.concurrent} based caches. * Provides a {@link org.springframework.cache.CacheManager CacheManager} * and {@link org.springframework.cache.Cache Cach
java的包注释
hqmln的博客
08-29 908
javadoc程序从下面几个特性抽取信息： 包 公用类与接口 公用的和受保护的(protected)方法 公用的和受保护的域 类注释必须放置在import之后，类定义之前 /** *类的描述 */ public Class Test(){  ..... } 注意： 我们在写注释的时候，生成api的时候发现没有包注释啊！也搞不清楚在那加了！ 其实包的注释是需要...
如何给"包"添加Javadoc注释
水墨青花的专栏
02-14 2710
今天刚好看了**公司的ava编程规范，也是建一个package.html放在当前目录下。 3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。 说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。 格式： 一句话简述。 详细描述。 产品模块名称和版本 公司版权信息 示例： 为 WEBSMAP 提供通信类，
java 包注释_【自学java笔记#第二十天#】包注释类注释和其他注释
weixin_31845811的博客
02-12 355
选用教材：《Java核心技术卷一》第四章 对象与类一、java程序设计中几种注释方式1、双斜杠注释(//)2、单斜杠+*号注释(/*......*/)3、双斜杠+*号注释(/**......*/)只有第三种注释方式可以生成注释文档二、生成注释(除包注释以外)文档的两种方式1、用eclipse工具生成注释文档：第一步：在程序中有需要的地方写好注释第二步：点击最顶上菜单的project第三步：选择Ge...
大数据必学Java基础（八）：简单介绍API和注释
07-21
Java API按照包（package）进行分类，如`java.util`用于通用工具类，`java.io`处理输入输出，`java.nio`支持非阻塞I/O等。在编程时，开发者应根据需求选择合适的类和方法，遵循API的使用规则。 二、注释 注释在...
掌握谷歌Guava工具包：Java8特性和反射注释技巧
使用Guava时，你可以利用它提供的丰富集合操作，如Multiset、Multimap、Table等，以及缓存机制如LoadingCache，这些都是Java标准集合库之外的重要补充。 4. Java8 Lambda表达式 Java 8引入了Lambda表达式，这是一种...
Android注释：:sparkles::sparkles::sparkles:这带有包小鱼干，确定不要吃嘛？（逃
01-28
2. 多行注释：以 `/*` 开始，`*/` 结束，适合对代码块进行详细解释。 3. Javadoc 注释：以 `/**` 开始，`*/` 结束，用于生成API文档，格式规范且包含特殊标签如`@param`, `@return`, `@throws`等。 在Android开发中...
javadoc2swagger：Java文档转Swagger自定义注释解析
这是通过分析Java代码文件中的JAX-RS注释（如@GET, @POST, @Path等）和Javadoc注释来实现的，特别是对于那些在JAX-RS注释中未提供的额外信息，可以通过Javadoc注释来补充。 通过该插件生成Swagger文档的优势包括： ...
JAVA基础——————注释，包
最新发布
2401_84727524的博客
04-30 695
String[]args ： 在方法名后面的小括号中，这是这个方法的参数，此处的String是字符串类型，String[] 是字符串数组类型， args 是变量名（参数名） ，这里面。static: 静态的，有且仅有一份的资源被称为静态资源， 主方法被static修饰，说明一个类中只能有一个主方法。public : 用于修饰公共的类，公共的类必须和源文件名保持一致，且一个源文件中只能由一个公共的类。main方法，也叫主方法，是Java程序的入口，Java程序要运行一定是先找main方法。
Java包注解和package-info.java文件的作用和用法
快乐李同学的博客
09-04 6239
1 问题背景 博主最近在深入学习Java注解，其中就了解到注解可用于修饰包声明，因为@Target元注解的value元素数组可以包含ElementType.PACKAGE元素，接着博主就发现@Deprecated注解就支持修饰包声明： package java.lang; import java.lang.annotation.*; import static java.lang.annotation.ElementType.*; @Documented @Retention(RetentionPolic
java package 注解,如何添加包级别注释或编辑package-info.java？
weixin_33237865的博客
02-16 634
I'm trying to add package level annotations but I don't have a clue on how to do it. Examples are appreciated.解决方案Summary from the article hereIn package-info.java:@PackageLevelAnnotationpackage blamm...
Java注释包装方法
西八老码
09-03 310
我有很多样板代码，基本上遵循以下模式： function doSomething() { try { [implementation] [implementation] [implementation] [implementation] } catch (Exception e) { MyEnv.getLogger().log(e); } finally { genericCleanUpMethod(); } } 我很想创建自己的注释来稍微清
java实现自定义包装注解
weixin_45067224的博客
11-04 1122
java实现自定义包装注解的方式不少，可以采用aop方式，还可以单纯采用拦截器配合ResponseBodyAdvice(响应结果处理）方式。这篇文章我用到的是第二种。 1. 自定义一个注解 @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.METHOD}) @Documented public @interface ResponseResult { } 作用：自定义的包装注解，可在controller.
Java注释详解
weixin_45998979的博客
04-25 511
JAVA常用的注释大概分为三种：单行注释、多行注释、文档注释。 单行注释 单行注释，也是最常用的一种注释，有一对正斜杠//开始，直至本行结尾。有的同学可能跟我一样常常弄不清正反斜杠的区别，简单说明一下，头朝右就是正斜杠，朝左就是反斜杠。 示例： package annotate; public class Text { public static void main(String[] arg...
java注解的使用
系统运维
10-25 107
注解作用是与编译器进行交涉的类，它可以可以加在包，类，字段，方法，方法的参数以及局部变量上。 JDK提供的注解： @Override 这个相信我们以前常常用到的吧，它就是用来告诉我们是重载了父类的某个方法的。 @Deprecated 当某个方法我们往后不想用了，但是如果删掉的话会带来很多麻烦（例如原先使用这个方法的人用不了这个方法了），所以我们加上@Deprecated标注，在后来的朋友...
Java包机制和文档注释
ilzy957的博客
03-29 432
Java包机制和文档注释 Java包机制 类似于不同文件夹里同名文件机制。 语法格式：package pkg1[.pkg2[.pkg3…]] 一般利用公司域名倒置作为包名，如www.baidu.com为com.baidu.www 为了导入其他成员的包，使用import，并且必须写在自己的包下面。例如:import com.ilzy.blog.test.test1 虽然不同包之间可以使用同样的文件名，但尽量不要重复，否则导入将会报错。 .*可以导入包内所有类。 JavaDoc 语法格式和参数信息：
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

细水长流cpu

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值