给 JAVA 加类注释

为了更好的描述 JAVA中的每一个类的作用,我们给所创建的每个类加上注释,让人能一目了然的看到该类是做什么的。

我用的是 MyEclipse ,要给它加类注释,选择 window下的 Preferences 中左边的  java下的 code Style 下的 code Templates ,在右边的
Configure generated code and comments : 下的 code 中选择 New Java files ,在下边的 Pattern: 中加想要的样式

如下所示:
${filecomment}
${package_declaration}


/**
 * <p>Title: ${file_name}</p>
 * <p>Description: xxxx平台软件</p>
 * <p>Copyright: Copyright (c) 2011-2012 xxx信息技术有限公司</p>
 * <p>Company: XXX信息技术有限公司</p>
 * @author 作者名
 * @version 1.0 创建时间:${date} ${time}
 */
${typecomment}
${type_declaration}


可以根据不同的需要选择 。希望能有所帮助!

Java 中,给方法添加注释主要是为了提供关于方法功能、参数含义、返回值以及特殊行为的文档说明。主要有三种型的注释: 1. **单行注释** (Single-line Comment): 使用 `//` 开头的一行文本作为注释,通常用于解释某一行代码的作用。例如: ```java int result = divideNumbers(10, 2); // 计算两个数相除的结果 ``` 2. **多行注释** (Multi-line Comment): 使用 `/* ... */` 包裹一段文本,可以跨越多行。适合对方法详细介绍: ```java /** * This method divides two numbers and returns the quotient. * @param num1 第一个操作数 * @param num2 第二个操作数 * @return 返回两数相除的结果 */ int divideNumbers(int num1, int num2) { return num1 / num2; } ``` 这里的 `@param` 和 `@return` 是 Javadoc 注释的一部分,用于描述方法的输入参数和返回值。 3. **Javadoc 注释**: 这是一种特殊的多行注释,主要用于自动生成 API 文档,通过IDE的工具如Eclipse或IntelliJ IDEA等会显示出来。它包含了更丰富的信息,如包、、成员变量、构造函数和方法的详细描述。 使用 Javadoc 的例子如下: ```java /** * @since 1.0 */ public class MyClass { /** * Calculate the sum of two numbers. * * @param a The first number * @param b The second number * @return The sum of the two numbers * @throws IllegalArgumentException if either parameter is negative */ public int addNumbers(int a, int b) throws IllegalArgumentException { // ... } } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值