Struts 2 中的注释

Struts 2 中的注释可以用于提供关于一些特定的代码块的信息，以及帮助程序员更好地理解和维护代码。本文将介绍 Struts 2 中常用的注释格式，包括普通注释、Javadoc 注释和注解等。

普通注释

普通注释是在代码中添加的文本注释，用于解释该行代码的作用。在 Struts 2 中，可以使用双斜杠 " // " 或者斜杠加星号 " /* */ " 来添加注释。

// 这是一个普通注释
int i = 0; // 这是一个注释，用于解释变量 i 的作用
/* 
这是一个多行注释，
可以用来注释一段代码或者多个代码块。
*/

Javadoc 注释

Javadoc 注释是一种特殊的注释，在注释块的开头添加 "/**"，并使用特定的语法格式，可以生成 API 文档。在 Struts 2 中，可以使用 Javadoc 注释为 action、方法和属性等添加文档。

/**
 * 这是一个 Javadoc 注释
 * 用于解释该类的作用和功能
 *
 */
public class MyAction extends ActionSupport {
    
    /**
     * 这个方法用于处理请求
     * 
     * @return 处理结果的状态码
     * @throws Exception 处理异常
     */
    @Override
    public String execute() throws Exception {
        // 处理请求
        return SUCCESS;
    }
    
    /**
     * 这是一个属性，用于保存用户名称
     */
    private String username;

    /**
     * 获取用户名称
     * 
     * @return 用户名称
     */
    public String getUsername() {
        return username;
    }

    /**
     * 设置用户名称
     * 
     * @param username 用户名称
     */
    public void setUsername(String username) {
        this.username = username;
    }

}

注解

注解是一种用于更好地描述程序元素的元数据，它可以添加到类、属性、方法和参数等上面。在 Struts 2 中，常用的注解包括 @Namespace、@Action、@Result、@Interceptor 和 @ExceptionMapping 等。

@Namespace("/users")
@ResultPath("/WEB-INF/content")
public class UserAction extends ActionSupport {

    @Action(value = "list", results = { 
        @Result(name = "success", location = "list.jsp") 
    })
    public String list() {
        // 处理列表请求
        return SUCCESS;
    }

    @Action(value = "add", results = {
        @Result(name = "success", location = "list", type = "redirectAction")
    })
    public String add() {
        // 处理添加用户请求
        return SUCCESS;
    }

    @Interceptors({ "loginInterceptor", "permissionInterceptor" })
    @ExceptionMapping(exception = "java.lang.Exception", result = "error")
    public String execute() throws Exception {
        // 处理请求
        return SUCCESS;
    }

}

总结

注释是程序代码中的重要组成部分，良好的注释和文档可以提高程序的可维护性和可读性。在 Struts 2 中，可以使用普通注释、Javadoc 注释和注解等多种方式添加注释，以及更好地描述和文档化程序元素。