-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
请为所有的属性与方法补充文档注释。
要求:
- 使用简体中文。
- 内容至少包含中文解释。
- 标有
@Resource注解的属性可不添加文档注释。 - 若为方法,需要为参数与返回值添加解释。
- 若为类,在类解释与类类型间插入一个空格。如:为
RoleController注释角色 控制器。 - 解释行的最后一行与
@开始的行间插入一个空行。
是否有部分注释需要保持英文,请讨论。
示例:
/**
* 角色 控制器
*
* @author AkagiYui
*/
@RestController
@RequestMapping("/role")
public class RoleController {
@Resource
private RoleService roleService;
/**
* 获取角色信息
*
* @return 角色信息 列表
*/
@RequestMapping({"/", ""})
@PreAuthorize("permitAll()")
public List<RoleInfoResponse> getRoles() {
return roleService.getAllRoles();
}
}Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers