我不喜欢Javadoc“常量字段值”页面列出字符串常量的方式。
例:
public static final String REGEXP_PATTERN = "^\\s*$";
在Javadoc页面上,该常量将列出一个值^\\s*$
,我认为这是完全错误的,应该是^\s*$
。
javac需要\
转义的事实是无关紧要的。该字段的值(如果您问我)是^\s*$
,这是Javadoc应该列出的内容。
有什么办法可以做到这一点?
面临的问题是-信不信由您-我们的Javadoc文档也正在由非Java人员使用。对于非Java人士来说,这毫无意义。
有什么办法可以做到这一点?
您将需要通过继承默认的子类来创建自己的doclet,通过对相关源代码的简短浏览可以发现,您只需要提供自己的子类即可,ConstantsSummaryWriterImpl
该子类的getValue(FieldDoc)
方法被替代以member.constantValue()
代替member.constantValueExpression()
。
要将编写器连接到适当的位置,您还需要子类HtmlDoclet
和重写configuration()
以返回您自己的子类,ConfigurationImpl
该子类又返回您自己的子类,WriterFactoryImpl
而该子类又返回您的自定义常量作家,最后使用该-doclet
选项javadoc
来告诉它使用您的自定义doclet而不是标准的doclet。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句