fpdb/docs/codingstyle.txt

26 lines
1.1 KiB
Plaintext
Raw Normal View History

This is just a loose collection of things so far, but might as well make a start :)
A word on wrapping: Please avoid making manual line breaks, the computer can and therefore should do it. Whether people use a phone or a 40" super-uber-HD screen, they should be allowed to use as much of it as they wish to.
Comments (or prints) with todo are things that are missing, bugs, or just messy code.
After every def (ie. at the end of the method) there should be a comment including the name, e.g.
#def end of parseActionLine
If you don't mind make names in java style, ie.:
Classes, files or tables like this: MyClassName
Methods and variables like this: myMethodName
License
=======
Trademarks of third parties have been used under Fair Use or similar laws.
Copyright 2008 Steffen Jobbagy-Felso
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.2 as published by the Free Software Foundation; with
no Invariant Sections, no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license can be found in fdl-1.2.txt
The program itself is licensed under AGPLv3, see agpl-3.0.txt