StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p>I believe nearly all of these fields are completely redundant, and add no value whatsoever to the descriptiveness of the file:</p> <ol> <li><p>The filename is possibly useful only during recovery from a disk crash? The preprocessor automatically includes it when it's useful (if you're trying to find a nasty header bug, for example).</p></li> <li><p>The purpose of a <code>.cpp</code> file will almost always be to contain the implementation of one or more <code>.h</code> files containing one or more class declarations. A comment describing the purpose of each class is better located in the header file just prior to the class declaration, where it is also more likely to be updated should the class's interface change.</p></li> <li><p>The author field will never be accurate, as soon as a single line change by a third party is made; use a revision control system's log / annotate / blame commands to track this in a reliable manner instead.</p></li> <li><p>"Modified by", "Created", and "RCS-ID" are similarly useless and prone to falling out of date. An RCS-ID may only identify the version of a file at last commit, it cannot account for any unversioned changes that have been made since. Instead, if you care about a file's exact version, use something robust like an MD5 sum instead.</p></li> </ol> <p>Which leaves the copyright notice and potential licence declaration, which in some jurisdictions are supposedly required:</p> <pre><code>/* Copyright 2009, Your Company Name. All right reserved. */ </code></pre> <p>Inserting this can easily be achieved with an editor macro.</p>

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