Javadocs package.html Vs package-info.java

I prefer not to use package-info.java. It creates problem in source code metrics, code coverage and unit testing metrics. There is a possibility that developers can put code inside.

Using package.html is clean way of writing java documentation. No confusion while looking at files. .html file is clearly visible among .java files. package-info.java file is difficult to find between similar file names.

Conclusion: I prefer to use package.html

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s