Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>If you or the other developers have not read Code Complete (or <a href="http://www.cc2e.com/" rel="noreferrer">Code Complete 2</a>) yet then stop what you are doing and read it.</p> <p>One thing that standands out is "A function should do just one thing and do it well". when such a function is named after the one thing it does well what further need is there for comment?</p> <p>Comments have the habit of going out of sync with the code they're supposed to be describing. The result can be worse than not having the original comment in the first place. Not only that but developers <em>know</em> that comments can age and can't be trusted. Hence they will read the code and discern for themselves what it is actually doing anyway! This kinda nullifies the point of putting the comments there in the first place.</p> <p>Having said that the same can be true of a function name, it may have been well named originaly but overtime new operations have been added to it that are not alluded to in the name.</p> <p>All comments seem to do separate out the lines of code a developer would prefer to be closer together so that they can see more per screenfull. I know my own re-action to a piece of code with lots of comments that I've got to understand. Delete all the comments. There now I can see what the code is upto.</p> <p>At the end of the day if your going to spend time <em>making things right</em> your time is far better spent refactoring the code to ensure its as reasonablly self-describing as it can be rather than just writing comments. Such an excercise pays off in other ways such as identifing common chunks of code.</p> <p>Its worth bearing in mind also that many good developers much prefer writing crisp clean C#, Java, whatever than the far less precise human languages with all the assumptions and ambiguities that they have. True most people with common sense would know how much detail is enough detail but good developers are not 'most people'. Thats why we end up with comments like <code>\\adds a to b and store it in c</code> (ok thats too extreme but you get the point).</p> <p>Asking them to do something they hate doing and are frankly not very good at (even if you're convinced its the right thing to do) is simply a battle already lost.</p>
    singulars
    1. This table or related slice is empty.
    1. POHow to convince people to comment their code
      singulars
      1. PTQuestion
    1. PTAnswer
    1. This table or related slice is empty.
    1. USAnthonyWJones
    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
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTDownMod
    3. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COI don't agree at all. I've worked on code that does complex calculations efficiently and which uses separate functions to compute different parts of a summation for good reasons. It needs a few simple, well-chosen comments to relate the equations to the code.
      singulars
      1. PO
      1. USThomas Kammeyer
    2. COThe average coding exercise though is not full of complex calculations. The vast majority of it is very boring and when the code is structured well with good naming its self-documenting. Do like commenting stuff?
      singulars
      1. PO
      1. USAnthonyWJones
    3. CO+1. Very well said! Only write comments if they don't rephrase what is already stated in code.
      singulars
      1. PO
      1. USDimitri C.
 

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