# JavaDoc 缩进：让代码更易读的魔法
在编程的世界里，代码的可读性是非常重要的。良好的可读性不仅能帮助开发者快速理解和维护代码，还有助于团队协作。JavaDoc作为Java中一种重要的文档工具，帮助开发者生成API文档，使得代码结构更加清晰。而在撰写JavaDoc时，合理的缩进是不可忽视的一个环节。
## 什么是JavaDoc？
JavaDoc是一个用于生成Java代码文档的工具，通
JS简介HTML 定义了网页的内容CSS 描述了网页的布局JavaScript 网页的行为基础知识用途一般把JavaScript代码放到一个单独的.js文件，然后在HTML中引入这个文件：<html>
<head>
<script src="/static/js/abc.js"></script>
</head>
<body&g
转载
2023-10-15 23:02:19
125阅读
JavaScript是灵活性非常高的一种脚本语言，使得用其实现的同样功能有多种多样的写法，那么在项目中如果没有统一的规范，就会造成javascript代码难以维护，随着项目的深入，性能j也越来越差，文件也越来越大。所以尽早制定统一的编码规范是非常必要的，下面是整理的一些javascript规范供大家参考。（1）编码格式好的编码格式，不同人有不同的看法，但是在同一个项目中一定要有统一的格式。下面是
转载
2023-08-28 14:56:02
141阅读
简介Javadoc用于描述类或者方法的作用。Javadoc可以写在类上面和方法上面。很多程序对Javadoc都不重视，认识不到Javadoc的作用，很多人都是这样认为的：“我只要写好功能就够了，写Javadoc太浪费时间，也没啥作用，还不如用写Javadoc的时间再多些个功能呢！”，我们知道注释是为了解释代码的作用的，是为了将来给自己或者别人快速了解代码的，在方法内一般用行注释//的比较多，是针对
转载
2024-06-20 12:51:43
102阅读
写作本文旨在加深自己印象，也为了更多人的了解到JS编码风格，提高自己的编码质量 想了解更多的内容请阅读《编写可维护的JavaScript》缩进每一行的层级由4个空格组成，避免使用制表符 (Tab) 进行缩进// 好的写法
if (true) {
doSomething();
}行的长度每行长度不应超过80个字符。如果一行超过80个字符，应当在一个运算符 (逗号, 加号等) 后换行。下一行应
转载
2023-12-11 07:45:48
48阅读
一、Javadoc的基本信息： javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +
转载
2023-05-18 22:56:51
256阅读
java提供了大量的基础类供我们使用，但是这么多的类，方法，我们是怎么知道的呢？从哪里可以查到呢？原来Oracle公司在为我们提供这些类的同时也为我们提供了相应的API文档，这些API文档就是告诉我们如何去使用这些类以及这些类的方法。 那么像这样的API文档是怎样制作的呢？ 其实java语言提供了一种很强大的注释功能：文档注释。我们在编写源代码的时候可以为这些代码添加合适的注释，然后通过J
转载
2023-05-24 15:35:57
508阅读
前言上篇我们演示了使用JDK的InvocationHandler实现动态代理，本文我们采用cglib来实现动态代理。 动态代理示例运用JDK的InvocationHandler是根据抽象接口来实现的，然而基于cglib来实现动态代理，被代理角色可以是一个普通的类，也可以是一个接口的实现类，总之，是基于类来实现的。首先我们在pom文件中增加cglib依赖：1 <dependency&
转载
2024-02-04 11:46:36
59阅读
JavaDoc命令是用来生成自己API文档的，将写好的程序放在生成的文档中 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 package com.wyd.base ...
转载
2021-10-11 00:28:00
139阅读
2评论
JAVADoc JavaDoc命令是用来生成自己的API文档的 参数信息 @author：作者名字 @versio：版本号 @since：指明需要的最早使用的jdk版本 @param：参数名 @return：返回值情况 @throws：抛出异常情况 ...
转载
2021-07-28 14:49:00
215阅读
2评论
一般利用公司域名倒置作为包名； www.baidu.com 包名：com.baidu.www ctrl+鼠标右键可以跳转到一些地方"IDEA" 用别的包要把别的包导入进来 import 包名.文件名； *代表通配符 会把这个包里所有的东西都导入进去 阿里巴巴开发手册 认真看一遍 JDK帮助文档 ht ...
转载
2021-08-26 17:20:00
183阅读
2评论
/** * The student class is basic class. * @author Leon * */ public class Student { /** * @param name The student's name * @param id student's id */ pu
转载
2020-02-08 20:43:00
84阅读
2评论
1.JavaDoc 2.JDK帮助文档 3.JavaDoc的参数信息 4.类在自己电脑的位置 5.用JavaDoc命令生成自己的API文档（javadoc -encoding UTF-8 charset UTF-8 文件名（要加后缀）） 6.如何在IDEA中生成一个Javadoc文档 1.首先新建一 ...
转载
2021-10-13 20:14:00
107阅读
2评论
javaDoc package test1; public class Doc { /** * @author wenyixin * @version 1.0 * @since 1.8 */ public static void main(String[] args) { //通过javadoc 参 ...
转载
2021-08-05 00:35:00
103阅读
介绍
JavaDoc就像是道路上的指路牌，虽然不能完全依赖，但确实很重要。既然如此，那总结一下还是很有必要的。
原创
2022-10-17 19:33:24
60阅读
2.8.4 @see：引用其他类所有三种类型的注释文档都可包含@see标记，它允许我们引用其他类里的文档。对于这个标记，javadoc会生成相应的HTML，将其直接链接到其他文档。格式如下：@see 类名@see 完整类名@see 完整类名#方法名每一格式都会在生成的文档里自动加入一个超链接的“See Also”（参见）条目。注意javadoc不会检查我们指定的超链接，不会验证它们是否有效。2.8
转载
2023-12-25 21:07:47
432阅读
一：简介Javadoc用于描述类或者方法的作用。Javadoc可以写在类上面和方法上面。https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html二：写在类上面的Javadoc写在类上的文档标注一般分为三段：第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束第二段：详细描述，通常用一
转载
2023-08-28 14:49:39
75阅读
Ashley J.S Mills<[email]ashley@ashleymills.com[/email]>Copyright 2005 The University Of BirminghamTable of Contents1. JavaDoc2. Installation3. JavaDoc Usage3.1. General Format3.2. Using javado
转载
精选
2007-01-19 00:31:06
844阅读
JavaDoc 用cmd生成javadoc命令生成Java文档 新建一个Doc.java类 javadoc -encoding UTF-8 -charset UTF-8 Doc.java 用idea 生产java文档 Tools-->Generate JavaDoc ...
转载
2021-09-25 16:24:00
154阅读
2评论
package base; /** @author xxx555 @version 1.0 @since 1.8 */ public class Doc { //javadoc命令是生产API文档的 String name; /** @author xxx555 @param name @retur ...
转载
2021-10-12 23:02:00
99阅读
2评论
