Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>@Fire Lancer: Right! I forgot about exception, but I would like to see them mentioned, especially the unchecked 'runtime' exception that this public method could throw</p> <p>@Mike Stone: </p> <blockquote> <p>you have to be diligent also to update the docs when you change the semantics of the method.</p> </blockquote> <p>Mmmm I sure hope that the <em>public API documentation</em> is at the very least updated whenever a change -- that affects the contract of the function -- takes place. If not, those API documentations could be drop altogether.</p> <p>To add food to yours thoughts (and go with @Scott Dorman), I just stumble upon <a href="http://today.java.net/pub/a/today/2008/09/11/jsr-305-annotations.html" rel="nofollow noreferrer">the future of java7 annotations</a></p> <p>What does that means ? That certain 'boundary conditions', rather than being in the documentation, should be better off in the API itself, and automatically used, at compilation time, with appropriate 'assert' generated code.</p> <p>That way, if a '@CheckForNull' is in the API, the writer of the function might get away with not even documenting it! And if the semantic change, its API will reflect that change (like 'no more @CheckForNull' for instance)</p> <p>That kind of approach suggests that documentation, for 'boundary conditions', is an extra bonus rather than a mandatory practice.</p> <p>However, that does not cover the special values of the return object of a function. For that, a <em>complete</em> documentation is still needed.</p>
    singulars
    1. This table or related slice is empty.
    1. POapi documentation and "value limits": do they match?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. This table or related slice is empty.
    1. USVonC
    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. COYou would be surprised how often developers don't update their javadocs when they change the semantics of a method... I have seen it A LOT. That said, frameworks and the language itself are usually good about it.
      singulars
      1. PO
      1. USMike Stone
    2. COThe new annotations: awesome if they come about, but you still need to document what the semantics of a null value are with say @Nullable. I find it best to be very explicit what passing null will actually do, and @Nullable only indicates that it's allowed, not what it does.
      singulars
      1. PO
      1. USMike Stone
    3. CO@Mike Stone agreed, seems the documentation is mandatory after all... As for the javadoc, I concur: in fact, in my 200 developpers project, the javadoc for public api is rarely documented! (sigh!)
      singulars
      1. PO
      1. USVonC
 

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