The JetBrains Blog
·
IntelliJ Scala插件中的Scaladoc支持
💡
原文英文，约900词，阅读约需4分钟。
📝
内容提要
Scala 3的Scaladoc默认使用Markdown语法，支持标题、列表、引用和代码块。IntelliJ Scala插件增强了Markdown支持，简化了文档编写。用户可通过指令切换回Wikidoc语法。
🎯
关键要点
- Scala 3的Scaladoc默认使用Markdown语法，支持标题、列表、引用和代码块。
- Scala 2使用Wikidoc语法，具有模板、类别和元数据等高级功能，但在代码注释中使用较少。
- Markdown语法更简单、可读性更强，已广泛用于README文件和其他文档。
- IntelliJ Scala插件增强了Markdown支持，简化了文档编写。
- Markdown语法支持多种格式，包括标题、列表、引用、加粗、斜体、链接和代码块。
- 可以通过在注释块末尾添加@syntax wiki指令切换回旧的Wikidoc语法。
- 在IntelliJ IDEA中，有三种方式渲染Scaladoc：点击Scaladoc行左侧的图标、悬停在注释块上、悬停在代码元素名称上。
❓
延伸问答
Scala 3的Scaladoc默认使用什么语法？
Scala 3的Scaladoc默认使用Markdown语法。
IntelliJ Scala插件如何增强Markdown支持？
IntelliJ Scala插件增强了Markdown支持，简化了文档编写，支持多种Markdown格式。
如何在Scaladoc中切换回Wikidoc语法？
可以通过在注释块末尾添加@syntax wiki指令切换回Wikidoc语法。
Markdown语法相比Wikidoc有什么优势？
Markdown语法更简单、可读性更强，已广泛用于README文件和其他文档。
在IntelliJ IDEA中如何渲染Scaladoc？
可以通过点击Scaladoc行左侧的图标、悬停在注释块上或悬停在代码元素名称上来渲染Scaladoc。
Markdown语法支持哪些格式？
Markdown语法支持标题、列表、引用、加粗、斜体、链接和代码块等格式。
➡️
