受け入れられているコーディングスタイルについて調べる方法
-
04-07-2019 - |
質問
ソースコードの書式設定(ベストプラクティス)を参照する場所、個々の言語、つまり変数などの命名規則、インデント、ブレースの配置場所、コメントの挿入方法、挿入場所など
たとえば、C KernighanとRitchieの本 Cプログラミング言語 Linus Torvaldsの Linuxカーネルコーディングスタイルガイドまたは GoogleのC ++スタイルガイドおよびPerlでは少なくとも perlstyle-Perlスタイルガイド。
編集:おそらく、「コーディングスタイルで良いスタートを切る方法」を尋ねるべきだったでしょう。
解決
このようなスタイルガイドについてはあまり説明しません。良いスタートですが、最終的にはあなたやあなたのチームが独自のコーディングスタイルを開発します。
編集:ロブ・カムは、これらの「開始条約」についてもっと知りたいとコメントしました。
それは良い点です。しかし、ほとんどの場合、既存のプロジェクト、オープンソースプロジェクト、または商用に参加し、それに取り組んでいる人々はすでにコードコンベンションを持っています。会社ではおそらくコード規約がすでに存在します。新しいプロジェクトを開始する場合は、以前に行った別のプロジェクトの規則から始めます。
以前に使用したことのない新しい言語で新しいプロジェクトを実際に開始する場合は、何らかの類似性のある別の言語の規則から始めることができます(つまり、新しいoo言語の場合はJavaの規則を使用できます)またはSmalltalk)を使用して、新しい言語の経験を積むときに規則を調整します。 Javaでプログラミングを始めたとき、Pascalコーディング規約を使用しました。いくつかのパスカル規約はJavaにはあまり適していませんでしたが、時間が経つにつれて、古い規約をいくつか廃止し、新しいものを開発しました。
S.Lottは、あなたが選んだ言語で書かれたオープンソースプロジェクトを調べるという考えを持っていました。良い慣習についていくつかの提案を得るのは良い考えです。 SrikanthはStackoverflowでここで良い慣習を求めることを考えていました。 Stackoverflowは、このようにコーディング規約の良いリファレンスになるので、非常に良いアイデアです。
他のヒント
本よりも優れているのは、好みの言語でオープンソースコードを見つけることです。
本ではなく、数人の著者や編集者の仕事である作業ソースコードは、高度に進化したコミュニティ標準を満たすコミュニティプロジェクトです。
クライアントからコーディング標準の支援を求められたとき、私は優れたオープンソースプロジェクトを見つけ、「xxxのように見せる」という短い標準ドキュメントを提供することを好みます。 Javaスタイルで使用する良い例は、Apache Ant プロジェクトです。
誰もがお気に入りのオープンソースのサンプルプロジェクトを持っています。実用的なコードを読んで、お気に入りを選んでください。そのプロジェクトをエミュレートします。
Googleを使用します。たとえば、Javaコーディングガイドラインを検索するには、このクエリまたはStack Overflowに投稿して、Javaの推奨コーディング標準ガイドラインを尋ねてください。すべての言語の単一のソースを指すのは困難です。
会社/プロジェクト用に1つを選択し、それを厳守し、それが適切な標準であることを確認することをお勧めします。
ボブおじさんのコードを消去することをお勧めしますコードスタイルの問題を心配しています。
見るべき3つの良い場所があります。
- 使用している言語の人気書籍。
- あなたの言語で書かれたオープンソースプロジェクト。
- 言語のCheckstyleタイプのユーティリティ。
CheckstyleやPMDなどのツールを使用する場合、「ルール」の多くがそれらの実施は議論の余地があるかもしれません。 ドキュメントを確認すると、注意すべきルールを見つけることができます。
には、 C#を使用していない場合でも、参照するのに役立つコーディング規約を含むリファレンスドキュメント。スタイルや基本的な規則を超えて、コードのクリーンアップなど、他の人が推奨するベストプラクティスの本>は、コードベースの将来のメンテナーにとって意味のある、保守可能で読みやすいコードを作成するために不可欠な読み物です。
Visual Studio(およびその他の最新のIDE)を使用している場合、推奨される規則との基本的な矛盾は自動的に下線が引かれます(VSの最近のバージョンでのホバーに関する提案があります)。 VSでは、チームが別の標準を使用する場合は、プロジェクトプロパティを開き、「コード分析」の設定を変更します。 (最後の左側のメニュー項目)。 詳細:ルールセットを使用してコード分析ルールをグループ化する
みなさん、こんにちは、良い日です
まあ私はそれが依存すると言う必要があります 会社で働いているかどうかによります またはあなたがあなたのために働いている場合;)
会社で働いている場合、命名スタイルやその他の規則を受け入れます
そしてあなたのために、あなた自身を含む誰もが何をどのようにすぐに理解できるスタイルを確立する必要があります
ブラケットなどがあなたの方法です
しかし、あなたが言ったように、個々の言語があるので、独自のルールがあります
そしてMnementhが言ったように、すべてのチームにはコーディングの方法が制限されているか自由な方法があるかもしれない
これですべて これ以上… バイバイ
CおよびC ++スタイルガイド、リンクの短いページクリストファー・ロットが管理しているUSENETからのスタイルガイド、コーディングルール、ディスカッションへ。
あなたが PHP の開発者なら、これら2つのガイドをお見逃しなく: