Alex Rivera | Logout

Why does the default IntelliJ default class javadoc comment use non-standard syntax?

Asked 2008-09-15T15:07:50.800
45

Why does the default IntelliJ default class javadoc comment use non-standard syntax? Instead of creating a line with "User: jstauffer" it could create a line with "@author jstauffer". The other lines that it creates (Date and Time) probably don't have javadoc syntax to use but why not use the javadoc syntax when available?

For reference here is an example:

/**
 * Created by IntelliJ IDEA.
 * User: jstauffer
 * Date: Nov 13, 2007
 * Time: 11:15:10 AM
 * To change this template use File | Settings | File Templates.
 */
intellij-idea javadoc
Edit
Report

2 Answers

4

The default is readable, usable, but does not adhere to or suggest any coding standard.

I think the reason IntelliJ doesn't use the Javadoc tags in the default, is so that it avoids possible interference with any coding/javadoc standards that might exist in development shops. It should be obvious to the user if the default needs to be modified to something more appropriate.

Where I am working, the use of author tags is discouraged, for various reasons.

answered 2008-10-03T00:53:54.363
3

Because it's a default file template that you're supposed to change to your organization's standard, or your tastes.

My best guess.

answered 2009-05-18T19:42:10.313

Your Answer