StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p>Those comments <em>do not belong in the javadoc</em> :-) The javadoc should explain the contract -- it is what is extracted and displayed in the auto-generated "documentation". The rest are just normal comments or, perhaps better yet in this case, SCM log entries and have no place in the javadoc!</p> <p>I would likely just leave the original author, but if you want credit...</p> <p>...see the <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@author" rel="noreferrer">@author</a> javadoc reference and note that it can be included multiple times. This section <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#multiple@author" rel="noreferrer">explicitly relates to multiple authors</a> and ordering, etc.</p> <pre><code>/** * This class does some really awesome stuff. * It uses PostreSQL. * * @author Steph the Great * @author Freddy Four Fingers */ // DEC2012 - Fred - Modified to use PostgreSQL instead of Derby (but really, use SCM!) class Awesome { ... } </code></pre> <p>Happy coding.</p> <hr> <p>Notes on question somewhat unrelated to example in post... if the author isn't known, then several things can be done. First and foremost <em>add a link or reference to where the original source was obtained</em> -- an optional "I didn't write this originally" for clarity can be noted as well.</p> <p>Then, depending upon your preference:</p> <ol> <li><em>Don't specify</em> an <code>@author</code> field -- not even yourself. <em>It's not required.</em></li> <li>Add yourself as the sole author; the original source is mentioned above in the javadoc</li> <li>Add a dummy author and yourself as the second author, e.g. <del><code>@author Unknown</code></del> <code>@author unascribed</code> (see comments and <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@author" rel="noreferrer">@author</a>).</li> <li>Do whatever you want within terms of the license, if any.</li> </ol>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload