💡
原文英文,约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:点击边栏图标、悬停光标、悬停代码元素名称。
➡️