Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>I do both, aided by Eclipse's autocomplete.</p> <p>First, I document the property:</p> <pre><code>/** * The {@link String} instance representing something. */ private String someString; </code></pre> <p>Then, I copy and paste this to the getter:</p> <pre><code>/** * The {@link String} instance representing something. */ public String getSomeString() { return someString; } </code></pre> <p>With eclipse, @return statements have an autocomplete - so, I add the word Gets, lowercase the "t", and copy the sentence with the lowercase "t". I then use @return (with Eclipse autocomplete), paste the sentence, and then uppercase the T in the return. It then looks like this:</p> <pre><code>/** * Gets the {@link String} instance representing something. * @return The {@link String} instance representing something. */ public String getSomeString() { return someString; } </code></pre> <p>Finally, I copy that documentation to the setter:</p> <pre><code>/** * Gets the {@link String} instance representing something. * @return The {@link String} instance representing something. */ public void setSomeString(String someString) { this.someString = someString; } </code></pre> <p>Then, I modify it and with Eclipse autocomplete you can get not only the @param tag but also the name of the parameter:</p> <pre><code>/** * Sets the {@link String} instance representing something. * @param someString The {@link String} instance representing something. */ public void setSomeString(String someString) { this.someString = someString; } </code></pre> <p>Then, I'm done. In my opinion, this templating makes it a lot easier, in the long run, to not only remind yourself what the property means through repetition, but also it makes it easier to add additional comments to the getter and setter if you want to add side effects (such as not allowing null properties, turning strings to uppercase, etc). I investigated making an Eclipse plugin for this purpose but I couldn't find the appropriate extension point for the JDT, so I gave up.</p> <p>Note that the sentence might not always start with a T - it's just the first letter has to be uncapitalized/recapitalized in pasting.</p>
    singulars
    1. This table or related slice is empty.
    1. POHow to write Javadoc of properties?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. This table or related slice is empty.
    1. USMetroidFan2002
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COCopy/paste is evil... and time consuming. These steps look like a lot of work, and if the javadoc changes you'll have 3 different places to update. I don't think a plugin would justify this either... atleast, then the plugin would have to e.g. consider the property javadoc to be the master and then overwrite getters (and setters). What I want to accomplish is to write the javadoc in 1 single place, and then have both getters and property javadocs assume the same description...
      singulars
      1. PO
      1. This table or related slice is empty.
    2. COTypically, properties don't change all that often. And the copy and paste operations, with Eclipse's autocomplete, takes less than 30 seconds once the property Javadoc is constructed.
      singulars
      1. PO
      1. USMetroidFan2002
    3. COI'm not convinced... Introduction of this type of copy/paste scheme is IMHO bound to lead to inconsistencies. I have too little faith in other cooks (or myself) editing the code later. Also, at least if you're not having a complete up-front design, javadoc properties is often subject to change, at least during a experimental/design phase. And javadoc will be of better quality if written when the code is fresh in mind... Sorry if I seem like a whiner ;-)
      singulars
      1. PO
      1. This table or related slice is empty.
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

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