DesignGuidelines/es

From Free Pascal wiki
Revision as of 07:30, 30 March 2006 by Mgsalvador (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Deutsch (de) English (en) español (es) français (fr) 日本語 (ja) 한국어 (ko) português (pt) русский (ru)

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.
  • Minimize the number of calls from Interfaces to LCL, when performing an action requested by the LCL. The interfaces only notify the LCL, never forces something. The LCL decides.
  • Naming convention, see Nomenclature
  • All code must work with all checks (range, io, overflow, stack) on. Besides that this helps debugging, some users put these checks into their fpc.cfg, so they are applied to whole lazarus. Including packages and examples.


New files
  • Every file should start with a header containing the license and a few lines describing the content.
  • Pascal sources should have lowercase filenames (.pas, .pp, .inc, .lfm, .lrs)


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



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


Texto traducido: Deutsch (de) English (en) español (es) français (fr) 日本語 (ja) 한국어 (ko) português (pt) русский (ru)

Pautas de codificación para Lazarus

Esto está dirigido a los desarrolladores de Lazarus:


Estilo de codificación
  • Puesto que un estilo es más fácil de leer, Lazarus sigue las líneas de la guía de estilo de la codificación de Borland. Por supuesto, casi cualquier persona encontrará algunos aspectos discutibles, que son menos legibles que otros estilos. Eso es cierto, intente seguir por lo menos el 90%.
  • Intente evitar círculos de la unidad. Esto hace más fácil gobernarla y cuando la unidad está creciendo permite partirla.
  • Reduzca al mínimo el número de llamadas de interfaces a LCL, al realizar una acción pedida por el LCL. Los interfaces notifican solamente el LCL, nunca fuerzan algo. El LCL decide.
  • Nombre según la convención, vea Nomenclatura
  • Todo el código debe funcionar con todas comprobaciones (rango, por ejemplo, desbordamiento, apilado). Además esto ayuda a la depuración, algunos usuarios ponen esas comprobaciones en su fpc.cfg, de modo que se aplican a todo Lazarus. Incluyendo los paquetes y los ejemplos.


Archivos nuevos
  • Todos los archivos deben comenzar con una cabecera que contiene la licencia y algunas líneas que describen el contenido.
  • Las fuentes del PASCAL deben tener nombres de fichero en minúscula (pas, pp, inc, lfm, lrs)


Archivos Include
  • Deben comenzar con la directiva {%MainUnit}


Paquetes
  • Deben tener una entrada .lpl en packager/globallinks/


Dialogos (formas modales)
  • Ciérrese en escape (si llave no usada de otra manera)
  • definen el botón del defecto y la vuelta lo activa (si llave no usada)
  • el medio a los diálogos complejos debe ser resizable y se almacena el tamaño


Artículos De Menú Del ;Main:

  • Si tenga una llave en keymapping.pp


' ' la versión de Authoritive puede ser encontrada adentro [ svn de http://svn.freepascal.org/svn/lazarus/trunk/docs/DesignGuidelines.txt ]. Las ofertas para la mejora se pueden agregar a la página de la charla (discusión) ' '.