IntelliJ类上方富格式注释添加方法求助
IntelliJ类上方添加格式化注释的方法
- 必须用JavaDoc格式注释:类上方写
/** ... */,普通/* ... */或//注释不支持格式化渲染 - Rendered视图下,JavaDoc支持基础Markdown语法,对应效果写法:
- 标题:用
#(一级)、##(二级),比如# 类功能说明 - 加粗文本:用
**需要加粗的内容** - 列表:每行开头用
-或* - 换行:空一行或者用
<br>标签
- 标题:用
- 示例代码:
/** # 用户管理类 处理系统内用户的注册、登录权限校验逻辑 **核心职责** - 验证用户注册信息合法性 - 处理用户登录请求 - 维护用户权限配置 */ public class UserManager { // 类业务代码 }
- 切换Rendered视图:点击编辑器右上角的「Rendered」按钮(和「Plain」切换),或用快捷键
Ctrl+Shift+Q(Windows/Linux)/Cmd+Shift+Q(Mac) - 检查设置确保生效:
- 打开
File > Settings > Editor > General > Appearance,勾选「Render documentation comments in editor」 - 进入
File > Settings > Editor > Code Style > Java > JavaDoc,确认Markdown支持已启用
- 打开
内容的提问来源于stack exchange,提问作者Ajay Kumar
相关产品推荐
相关产品推荐

