Ligne directrices de codage pour Lazarus

Style de codage

• Comme un style est plus facile à lire, Lazarus suit les lignes du Guide du style de codage de CodeGear. Bien sûr, presque n'importe qui trouvera quelque points dedans, qui sont probablement moins lisibles que d'autres styles. C'est vrai, mais essayez d'en suivre au moins 90%. Voir la LCL pour les exemples.
• Essayez d'éviter les unités cycliques (la section uses dans des sections implémentation). Raisons :
  • 1 - FPC a des problèmes avec.
  • 2 - Cela permet de découper les unités et les paquets quand ils sont devenus gros.
• Minimisez le nombre d'appels depuis des Interfaces vers la LCL, quand vous faites une action requise par la LCL. Les interfaces ne font que notifier la LCL, ne forcent jamais rien. La LCL décide. (Ndt : cette recommandation est nébuleuse, mal comprise : "Minimize the number of calls from Interfaces to LCL, when performing an action requested by the LCL. The interfaces only notify the LCL, never force something. The LCL decides").
• Convention de nommage : voir Nomenclature
• Tout le code doit fonctionner avec tous les contrôles (étendue(range), E/S, débordement, pile) activés.
• All code must work with all checks (range, I/O, overflow, stack) on. Mise à part le fait que cela aide au débogage, certains utilisateurs mettent ces contrôles dans leur fpc.cfg, ainsi c'est appliqué globalement à tout Lazarus - y compris les paquets et les exemples.
• Noms dans les commentaires : les commentaires doivent aider le lecteur. Ils ne sont pas là pour glorifier le rédacteur. Vous pouvez ajouter un nom si vous êtes le mainteneur connu pour être affecté aux rapports de bogue ou si le nom est un bon terme de recherche pour trouver de l'aide sur ce sujet.

Nouveaux fichiers

• Chaque fichier devrait commencer avec un entête contenant la licence et quelques lignes décrivant le contenu.
• Les sources Pascal devraient avoir des noms de fichiers en minuscules (.pas, .pp, .inc, .lfm, .lrs). Vous pouvez utiliser la casse de chameau (CamelCase) pour les noms d'unité.

Fichiers d'inclusion

• Ils devraient commencer par la directive {%MainUnit}.

Paquets

• Ils devraient avoir une entrée .lpl dans packager/globallinks/
• Ils devraient avoir un auteur, une description et une licence.

Entrées du menu principal
(toute allusion gastronomique est fortuite)

• Elles devraient avoir une clé dans keymapping.pp

---

La version faisant autorité peut être trouvée svn. Les proposition s d'améliorations peuvent être ajoutées dans la page de discussion ("Talk page").

GUI

Voir Lignes directrices de conception des IHM

Voir aussi

• Norme de codage Free Pascal (FPC) (utilisée pour le compilateur et autre codes FPC): Coding style(en)

---

From the Free Pascal wiki, page "DesignGuidelines/fr", as it stood on 2017-02-23 after a change by E-ric, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's Licensing page. If you have concerns about this material, message the admin.