我正在编写有关 Scala 库的文档。当我引用某个包时,我使用一个字符串来执行此操作,例如,"com.my.example"
但宁愿以一种在出现任何中断时给我编译错误的方式执行此操作(例如(com.my.example).mkString
)。
当然,我的 IDE 在重构时会警告我这种情况,并建议为我修复这些字符串。我只是更喜欢依赖编译器而不是 IDE。这在某种程度上可能吗?(在每个包中创建要引用的伪类不是一种选择)。
我正在编写有关 Scala 库的文档。当我引用某个包时,我使用一个字符串来执行此操作,例如,"com.my.example"
但宁愿以一种在出现任何中断时给我编译错误的方式执行此操作(例如(com.my.example).mkString
)。
当然,我的 IDE 在重构时会警告我这种情况,并建议为我修复这些字符串。我只是更喜欢依赖编译器而不是 IDE。这在某种程度上可能吗?(在每个包中创建要引用的伪类不是一种选择)。
编译器不包含注释,因此不会中断。您需要使用 scaladoc 而不是 scalac。当您生成文档时,您将看到损坏参考的警告。例如,我故意拼错了 immutable 并收到以下警告:
[warn] C:\...\Foo.scala:4: Could not find any member to link for "scala.collection.ommutable".
关键是将您的引用括在双括号 [[ ]] 中,例如:
/**
* This is my link [[scala.collection.ommutable]]
*/