java doc 代码文档

最新推荐文章于 2025-05-22 10:30:33 发布

原创最新推荐文章于 2025-05-22 10:30:33 发布 · 259 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发工具

JDK 专栏收录该内容

42 篇文章

订阅专栏

本文详细阐述了Javadoc在软件开发过程中的关键作用，通过实例展示如何规范地使用Javadoc进行类、字段、方法的注释，并介绍了如何利用Eclipse文档生成工具自动生成API文档，提升代码可读性和维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

对于代码规范不解释了，网上很多。

在编写代码的时候，有一点灰常的重要，那就是java doc.
可能会有人说，我没有使用过[说实话，我以前也没怎么在意].

最近在写代码的时候，查看业务逻辑，感觉代码中跳来跳去，实在是不方便。
在查看jdk API的时候，为什么我们不可以生成这么一个文档。

于是开始注意代码的注释，每个类，字段，方法说明都采用标准的java doc.

标准代码注释如下:


package com.ycl;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * 用户 是为{@link Test} 类作服务的
 * 
 * @author ycl
 * @version 1.0 2012-7-13 上午11:24:43
 * @see Test
 * @since 1.0
 * 
 */
public class Persion {

	/** Map with String keys and Object values */
	public final Map<String, Object> attributes = new LinkedHashMap<String, Object>(
			0);

	/**
	 * 根据名称获取方法
	 * 
	 * @param name 方法参数
	 * @throws NullPointerException 当name为空的时候将抛出这个异常
	 * @return 方法名称
	 */
	public String getMehtod(String name) {
		return null;
	}
}

接下来可以使用eclipse的文档生成工具，最后生成api如下:


com.ycl 
类 Persion
java.lang.Object
  com.ycl.Persion

--------------------------------------------------------------------------------

public class Persionextends java.lang.Object用户 是为Test 类作服务的 


从以下版本开始： 
1.0 
版本： 
1.0 2012-7-13 上午11:24:43 
作者： 
ycl 
另请参见：
Test