Skip to content

为属性和方法修正与补充文档注释。 #2

@AkagiYui

Description

@AkagiYui

请为所有的属性与方法补充文档注释。

要求:

  1. 使用简体中文。
  2. 内容至少包含中文解释。
  3. 标有 @Resource 注解的属性可不添加文档注释。
  4. 若为方法,需要为参数与返回值添加解释。
  5. 若为类,在类解释与类类型间插入一个空格。如:为 RoleController 注释 角色 控制器
  6. 解释行的最后一行与 @ 开始的行间插入一个空行。

是否有部分注释需要保持英文,请讨论。

示例:

/**
 * 角色 控制器
 *
 * @author AkagiYui
 */
@RestController
@RequestMapping("/role")
public class RoleController {

    @Resource
    private RoleService roleService;

    /**
     * 获取角色信息
     *
     * @return 角色信息 列表
     */
    @RequestMapping({"/", ""})
    @PreAuthorize("permitAll()")
    public List<RoleInfoResponse> getRoles() {
        return roleService.getAllRoles();
    }

}

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions