DesignGuidelines/ja

From Lazarus wiki
Jump to: navigation, search

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

Lazarusのコーディングガイドライン

このドキュメントはLazarusの開発者向けです

コーディングスタイル
  • スタイルの統一はコードの可読性を高めます。LazarusはBorlandのコーディングスタイルガイドラインに倣っています。いくつかのポイントにおいては、もちろんそれに倣っていない部分があるかもしれません。しかし、それは一向に構いません。少なくとも90%がそれに倣っていれば構わないのです。
  • ユニットが閉鎖構造(訳注:おそらく、AというユニットがBに依存し、BがAに依存するような状態の事)を持たないように留意してください。そうすればコードをナビゲートする事がより簡単になります。そしてまた、ユニットの分離や成長を容易にします。
  • 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.
  • ネーミングの規則は、用語体系をご覧下さい
  • 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.
新しいファイル
  • すべてのファイルの始めにはライセンスを記し、また適当な行にファイルについての説明を記すようにしましょう。
  • Pascalのソースコードは小文字のファイル名を使用すべきです (.pas, .pp, .inc, .lfm, .lrs)。
インクルードされるファイル
  • {%MainUnit } 指令から開始すべきです。
パッケージ
  • .lplエントリをpackager/globallinks/に持つべきです
ダイアログ (モーダルダイアログ)
  • Escapeキーで閉じる事ができるようにしてください(別の事に割り当てられていないなら)。
  • デフォルトボタンはリターンキーに対応させてください(別の事に割り当てられていないなら)。
  • 複雑なダイアログはサイズの変更ができるようにしてください。またサイズが保持されるようにしてください。
メインメニューアイテム
  • keymapping.ppを参照してください。



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