如何通过sbt doc命令显示Javadoc的@author标签?
嘿,我来帮你解决这个问题!在SBT里生成带@author标签的Javadoc确实不能直接像原生javadoc命令那样加命令行参数,得通过SBT的配置来实现,具体有两种方法:
永久配置(推荐):修改项目根目录下的
build.sbt文件,添加以下配置:Compile / doc / javadocOptions ++= Seq("-author")如果你还想显示
@version标签,可以把参数扩展成:Compile / doc / javadocOptions ++= Seq("-author", "-version")保存配置后,直接运行
sbt doc就能生成包含@author信息的Javadoc了,后续每次执行该命令都会自动应用这个配置。临时生效:如果只是想单次生成带@author的Javadoc,不想修改
build.sbt,可以在命令行直接传递配置:sbt 'set Compile / doc / javadocOptions ++= Seq("-author")' doc这个命令只会在本次运行中生效,下次执行
sbt doc还是会用默认配置。
原理其实很简单:SBT的doc任务会将javadocOptions里的参数传递给底层的javadoc命令,所以只要把-author加入到这个参数列表里,就能让生成的Javadoc显示@author标签了,这个配置完全适用于PlayFramework项目,因为Play本身就是基于SBT构建的。
内容的提问来源于stack exchange,提问作者Zenoo
相关产品推荐
相关产品推荐

