Changes between Version 2 and Version 3 of Development/CodingConventions


Ignore:
Timestamp:
04/18/09 15:48:54 (11 years ago)
Author:
ibboard
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CodingConventions

    v2 v3  
    33
    44The coding conventions are not written in stone (and some older code won't fit the coding conventions as two years in a more structured development environment have changed my thoughts on some things) but there are some guidelines that will keep code consistent.
     5
     6== File Headers ==
     7
     8All of the WarFoundry code is currently licensed under the LGPL v3. This means that there must be a copyright line and a license line at the top of each file, plus all projects must include the COPYING.LGPL and COPYING.GPL files. Although GNU recommend putting a large chunk of comments at the top of the page this is generally excessive and can be replaced with the following:
     9
     10{{{
     11 This file (${FileName}) is a part of the ${ProjectName} project and is copyright ${Year} ${CopyrightHolder}
     12
     13 The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license.
     14}}}
     15
     16If this is used in MonoDevelop then all of the variables will be replaced with valid values (as long as you've filled out the "Author Information"). Other applications may have similar templating for auto-inserted headers. The final alternative is to add the values manually.
    517
    618== Capitalisation ==