开发者

Javadoc text for variables within main method

开发者 https://www.devze.com 2023-04-10 08:13 出处:网络
I was wondering if it is possible to generate Javadoc text for important variables within the main method of a class.

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
     */开发者_C百科
    BufferedWriter report_stream = null; 
    ....

This is an example of a variable whose description I would like displayed in Javadoc. Thanks.


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.

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号