Embarcaderoは、言語スタイルガイドの更新版をdocwikiサイトで公開しました。このドキュメントは、最新のDelphi言語機能と、コーディングスタイルの変更をカバーするために更新されています。
ここ数ヶ月、今日のDelphi言語のための新しいObject Pascalスタイルガイドを出版するための努力をしてきました。以下は序文です。
“このドキュメントは、最初のバージョン(Delphi 1.0)がリリースされたときにBorlandのCharlie Calverによってが作成された古典的なObject Pascalスタイルガイドの更新版です。この更新されたドキュメントは、DelphiのプロダクトマネージャーであるMarco Cantuによって監修され、エンバカデロ社内のR&Dチーム、DelphiのMVP、Delphiのコミュニティ全体からの貢献を受けています。”
このスタイルガイドに記載されている内容は、言語ガイドではなく、コードを書く際のホワイトスペース(空白)やフォーマットの使い方を説明しています。これはコンパイラが一般的に無視する項目です。よってここでは何も義務づけられておらず、コードの可読性を優先するための推奨事項に過ぎません。これらのルールに従うことは、エンバカデロ社内のR&Dチームおよびすべてのコントリビューター (寄稿者)の要件となります。
新しいDelphiのObject Pascal スタイルガイドは、以下のURLからご覧いただけます。
http://docwiki.embarcadero.com/RADStudio/Sydney/en/Delphi’s_Object_Pascal_Style_Guide (英語)
以下は、このドキュメントのインデックスです。
- Introduction
- General Rules: Identifiers, Keywords, Indentation
- Source Code Files, Units and Their Structure
- White Space Usage
- Comments
- Statements
- Type Declarations
このブログでは、簡単にこのドキュメントの冒頭部を紹介して終わりにいたします。
Embarcaderoでは、ソースコードの可読性と保守性を向上させるために、エンバカデロ社内のR&Dやこのプロジェクトに関わるすべての開発者が使用する一連のガイドラインを定義しました。Embarcaderoは、Delphiコミュニティ全体がこのコーディングおよびフォーマットのスタイルを採用することを推奨します。
それをうまく表現しているのが、Object Pascalスタイルガイドの原版の序文です。
“Object Pascalは美しくデザインされた言語です。その大きな美点の一つは、その読みやすさです。このスタンダードは、Object Pascalコードの可読性を高めるために設計されています。開発者は、このガイドに記載されている簡単な規約に従うと、読みやすい統一されたスタイルを使用することで、すべてのDelphi開発者に利益をもたらす標準を促進することになります。また、これらの標準を守ることで、開発者のソースコードの価値が高まり、特にメンテナンスやデバッグの際に役立ちます。”
このドキュメントでは、言語の構文や文法については言及せず、説明もしていません。空白やフォーマットに関してさまざまな選択肢を認めることで、言語が選択可能な場所でのコード記述スタイルを定義することにのみ焦点を当てています。
これらのガイドラインはいずれも定まったものではなく、時間の経過とともに言語も進化することを期待しています。