どの Delphi コーディング標準ドキュメントに従っていますか?
私たちの会社は、コードの読みやすさ、レビューのしやすさ、および保守のしやすさを改善するために、いくつかのより良いコーディング標準を導入することを検討しています。CodeGear の「Object Pascal スタイル ガイド」に出くわしましたが、かなり長い間触れられておらず、多くの人が部分的な改善や追加を行っていると思います。公開されているいくつかのバリエーションやその他のドキュメントに出くわしました。以下にリストします。
NB: 私はスタイル戦争を始めたくありません。あなたが従う基準とその理由を知りたいだけです。
ありがとう。
Project JEDI Delphi 言語スタイル ガイドと JCL の追加
(CodeGear の「Object Pascal Style Guide」の拡張)
https://wiki.delphi-jedi.org/wiki/Project_JEDI_Delphi_Language_Style_Guide
(古いリンクが機能しなくなったことを報告してくれた Jeroen Pluimers と AmigoJack に感謝します。また、この最新のリンクも機能しなくなった場合に備えて、インターネット アーカイブ リンクを参照してください。)
コーディング標準を過剰に設計して、コードの記述を妨げる傾向がある可能性があります。
Jozzのコメントに同意します。推奨されるすべての標準を確認し、1つを選択してコーダーに強制するか、チームをプロセスに参加させることができます。
私の経験では、チームを関与させる最善の方法は、チームに採用のアイデアと利点を考えさせることです。あなたの既存の才能はあなたの最高のリソースです。同様に、彼らが買わない道を彼らに強制するならば、彼らはあなたの究極の敵になることができます。
したがって、既存のコーディングバリアントを確認し、チームをまとめて次の点について活発な議論を行ってください。
最も重要な目的は、チームと会社に最適な「標準」を確立することである必要があります。
なんらかの歴史的な理由から、私の職場でのコーディング標準は、デルファイと SQL の両方で、すべてのキーワードを大文字にすることです。Caps Lock に感謝します。
1つを選んでそれに固執する限り、それは本当に問題ではありません. コーディング標準は方言のようなもので、チームの全員が同じ方言を話していれば問題ありません。
とはいえ、ランタイム ライブラリ (VCL) やドキュメントで使用するのと同じ標準を選択してみませんか? そうすれば、全員が同じ方言を話すことになり、ランタイム ライブラリ コードを読みやすくなります。また、コーディング規約を説明するためのコード例がたくさんあります。
CodeGear の「Hungarian peanut butter」、識別子の命名用