The JetBrains Blog
·
IntelliJ IDEA现在支持Scaladoc中的Markdown！
内容提要
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：点击边栏图标、悬停光标、悬停代码元素名称。
延伸解读
Markdown与Wikidoc的比较
Scala 3的Scaladoc默认采用Markdown语法，相较于Wikidoc，Markdown更为简洁易读。虽然Wikidoc提供了模板和元数据等高级功能，但在实际代码注释中使用较少。Markdown的广泛应用使得开发者在编写文档时能够更快速上手，提升了文档的可维护性。
IntelliJ插件的增强功能
IntelliJ Scala插件对Markdown的支持显著增强了Scaladoc的文档编写体验。用户可以利用自动生成的索引和列表功能，快速组织文档内容。此外，插件还支持多种文本格式化选项，如加粗、斜体和链接，使得文档更加丰富和易于理解。
切换语法的注意事项
在使用Scaladoc时，如果需要切换回Wikidoc语法，必须在注释块的指令部分正确放置@syntax wiki指令。错误的位置可能导致后续内容无法正确渲染，因此开发者在切换语法时需特别注意指令的放置位置，以避免文档渲染问题。
延伸问答
Scala 3的Scaladoc默认使用什么语法？
Scala 3的Scaladoc默认使用Markdown语法。
IntelliJ Scala插件如何增强Markdown支持？
IntelliJ Scala插件增强了Markdown支持，简化了文档编写，支持多种Markdown语法特性。
Markdown语法相比Wikidoc有什么优势？
Markdown语法更简单、可读性更强，已广泛用于README文件和其他文档。
如何在Scaladoc中切换回Wikidoc语法？
可以通过在注释块的指令部分添加@syntax wiki指令来切换回Wikidoc语法。
IntelliJ IDEA中如何渲染Scaladoc？
可以通过点击边栏图标、悬停光标或悬停代码元素名称来渲染Scaladoc。
Markdown支持的语法特性有哪些？
Markdown支持标题、列表、引用、加粗、斜体、链接、代码锚点等语法特性。
