main 方法中变量的 Javadoc 文本
我想知道是否可以为类的 main 方法中的重要变量生成 Javadoc 文本。
public static void main(String[] args) {
/**
* Writes statistical information to results file
*/
BufferedWriter report_stream = null;
....
这是一个变量的示例,我希望在 Javadoc 中显示其描述。 谢谢。
I was wondering if it is possible to generate Javadoc text for important variables within the main method of a class.
public static void main(String[] args) {
/**
* Writes statistical information to results file
*/
BufferedWriter report_stream = null;
....
This is an example of a variable whose description I would like displayed in Javadoc.
Thanks.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
不。Javadoc 用于生成 API 文档,而不是实现文档。
但是,如果需要,您可以将缓冲编写器包装在另一个类中并记录该类。
No. Javadoc is for generating documentation of the API, not the implementation.
However you could wrap the buffered writer in another class and document that, if required.