Difference between revisions of "DesignGuidelines"

From Lazarus wiki
Jump to navigationJump to search
m (formatting)
(Added link to cvs version.)
Line 24: Line 24:
 
* Should have a key in keymapping.pp
 
* Should have a key in keymapping.pp
  
''Proposals for improvement can be added to talk page (discussion)''.
+
 
 +
-----
 +
''Latest version can be found in [http://www.freepascal.org/cgi-bin/viewcvs.cgi/projects/lazarus/docs/DesignGuidelines.txt?rev=HEAD cvs]. Proposals for improvement can be added to talk page (discussion)''.

Revision as of 07:03, 12 March 2005

Coding Guidelines for Lazarus

This is for lazarus developers:

Coding style
  • Since one style is easier to read, Lazarus follows the Borland Coding style guide lines. Of course, almost anyone will find some points there, that are arguable less readable than other styles. That's ok, just try to follow at least 90%.
  • Try to avoid unit circles. This makes it easier to navigate and when unit is growing allows to split it.
New files
  • Every file should start with a header containing the license and a few lines describing the content.
Include files
  • should start with the {%MainUnit } directive
Packages
  • should have an .lpl entry in packager/globallinks/
Dialogs (modal forms)
  • Close on Escape (if key not used otherwise)
  • Define default button and Return activates it (if key not used)
  • Medium to complex dialogs should be resizable and size is stored
Main Menu Items
  • Should have a key in keymapping.pp



Latest version can be found in cvs. Proposals for improvement can be added to talk page (discussion).