タグ付けされた質問 「code-formatting」

コードの読みやすさと一貫性のある外観に焦点を合わせます:語彙レベルの理解度はコーディングスタイルの基本要素です

30
中括弧は独自の行に表示する必要がありますか?[閉まっている]
中かっこは独自の行にあるべきですか?あなたはそれについてどう思いますか? if (you.hasAnswer()) { you.postAnswer(); } else { you.doSomething(); } またはそれがあるべき if (you.hasAnswer()) { you.postAnswer(); } else { you.doSomething(); } あるいは if (you.hasAnswer()) you.postAnswer(); else you.doSomething(); 建設的にしてください!理由を説明し、経験を共有し、事実と参考文献でバックアップします。

17
すべての開発者に同じコード形式を課すことは良い考えですか?
プロジェクトに単一の標準コード形式(Eclipseでの保存アクションを伴う自動形式)を課すことを検討しています。その理由は、現在、複数(10人以上)の開発者が使用するコード形式に大きな違いがあるため、ある開発者が別の開発者のコ​​ードで作業することを難しくしているためです。同じJavaファイルが3つの異なる形式を使用する場合があります。 だから私は利点が明確であると信じています(読みやすさ=>生産性)が、これを課すことは良い考えでしょうか?そうでない場合、なぜですか? 更新 私たちは皆Eclipseを使用しており、誰もがこの計画を認識しています。ほとんどの人が既に使用しているコード形式がありますが、一部の人は独自のコード形式に固執することを好むため、強制されていません。上記の理由により、強制することを好む人もいます。

30
コードを紙に印刷するのは一般的ですか?[閉まっている]
次の理由から、コードの行を80文字以下に抑えるのが好きです。 水平スクロールをする必要はありません。 この制限を超えると、おそらく行が複雑すぎます。そして 紙にきれいに印刷されます。 後者については、実際にコードを印刷して見る人(私もそのうちの1人)に会ったことがあります。それで、コードを印刷するのはどれくらい一般的ですか?

29
コードでどのように空白行を使用しますか?
空白については、中括弧の配置について既にいくつかの意見があります。 私自身は、「論理的」なグループに属するものを分離するために、コードに空白行を振りかける傾向があり、できれば次の人が作成したコードを読みやすくすることを願っています。 実際、私は書くようにコードを構造化すると言います。数行(10行よりも短い)より長くない段落を作成し、各段落を自己完結させようとします。 例えば: クラスでは、一緒に行くメソッドをグループ化し、それらを次のグループから空白行で分けます。 コメントを書く必要がある場合は、通常、コメントの前に空白行を入れます メソッドでは、プロセスのステップごとに1つの段落を作成します 全体として、私はめったに4/5以上の行が一緒にクラスター化されることはなく、非常にスパースなコードを意味します。 私は実際にコードを構造化するためにそれを使用しているので(実際にインデントを使用しているので)、この空白すべてを無駄とは考えていません。 例えば: for (int i = 0; i < 10; ++i) { if (i % 3 == 0) continue; array[i] += 2; } 2つのステートメントには明確な明確な目的があるため、明確にするために分離する必要があると思います。 それでは、実際にコードで空白行を使用する(または使用しない)方法は?

14
リッチコードの書式設定が一般的ではないのはなぜですか?
私はCode Completeを読んでいて、レイアウトとスタイルの章で、彼はコードエディターが何らかのリッチテキスト形式を使用すると予測していました。つまり、このようなコードの代わりに Procedure ResolveCollisions { Performs a posteriori collision resolution through spatial partitioning algoritm } ( CurrentMap : SpriteContext, PotentialColliders: SpriteList ) var Collider : Sprite, Collidee : Sprite, Collision : SpriteCollision begin DoStuff(); end. 次のようになります。 手順 ResolveCollisions 空間分割アルゴリズムにより事後衝突解決を実行します パラメーター CurrentMap : SpriteContext PotentialColliders : SpriteList ローカル変数 Collider : Sprite …

5
VCSを使用するときにコードをフォーマットするのは悪いことですか?
コミットする前に、ほとんどの場合、コードを適切にフォーマットするようにフォーマットします。私のチームのほとんどは、実際には気にせず、常にコードを適切にフォーマットしません(コードに影響を与えないが、保守しようとするときの可読性に影響を与える小さなこと)。 私は最近、「保存時にフォーマット」オプションを持つVSパワーツールをインストールし、以前にフォーマットされていないファイルに変更を加えました。開発VPが私のところに来て、フォーマットのために私をre責しました。なぜなら、マージツールでは、1行または2行ではなく、ファイル全体がほとんど変更されているように見えるためです(したがって、彼は私が簡単に変更したものを正確に見ることができません)将来的に保存時にフォーマットを無効にするように言われました。私はその懸念を理解していますが、フォーマットされていないコードをソートすることは時々困難であり、IMOはとにかく常に適切にフォーマットされるべきです。気まぐれに再フォーマットするだけではないことに注意してください。しかし、コードを書くときは、パワーツールを使用するか、キーコマンドを押してテキストをフォーマットし、読みやすくします.SVNでは次のように表示されます変更。 だから私は尋ねます、常に実際にコードをフォーマットすることは悪いことですか?彼の懸念は、コードが読み取り可能であることを確認するよりも妥当ですか?

5
自動フォーマットを使用してEclipseでコードをフォーマットすることは良いアイデアですか?
私はコーディングにEclipseを使用しており、使用する言語はJavaです。自動フォーマッター(CTRL + SHIFT + F)を使用してコードを適切にフォーマットするように誰かから提案された後、このコマンドはコードをフォーマットしますが、時々全体的な外観が奇妙になり、実際には非常に読みにくいと感じます。 これは推奨されることですか?そうでない場合は、Eclipseでコードをフォーマットする方が良いですか?

3
PHPファイルの終了タグ(?>)?
PHPファイルを?>で閉じることを誓う人もいれば、それを残す方がより最適化されていると言う人もいます。 そこにそれを置くことは必須ではないことを知っています、私はこれを行うことの長所と短所が何であるか、そしてベストプラクティスは何であるか疑問に思っています。

6
コードフォーマッティングSQLクエリ
SQLクエリを別の行に分割する必要がありますか?たとえば、私が取り組んでいるプロジェクトでは、1600列を使用するクエリがあります!1600 +タブ文字。次のようなクエリを作成しました。 "SELECT bla , bla2 , bla FROM bla " . "WHERE bla=333 AND bla=2" . "ORDER BY nfdfsd ..."; しかし、彼らは私にそれらを一行に入れるよう要求し、私のスタイルは悪いフォーマットだと言った。なぜそれが悪い習慣ですか?

3
コードに保存されているSQLクエリを整理する最良の方法は?(またはあなたがすべきですか?)[閉じた]
閉じた。この質問はより集中する必要があります。現在、回答を受け付けていません。 この質問を改善したいですか?この投稿を編集するだけで1つの問題に焦点を当てるように質問を更新します。 5年前に閉鎖されました。 SQLクエリで散らかったコードのページを見たときにイライラするのは私だけではないはずです。ActiveRecordおよびその他のORMパターンは、プロジェクトで使用される大量のSQLを軽減するのに役立ちますが、複雑なクエリの多くの場合、SQLの使用は避けられないようです。 SQLクエリを他のコードと一緒に(または外部的に)整理して、どこにでも散らばらないようにする方法についての意見を探していますか?1つの明白なアイデアはビューの使用ですが、多くの場合、ビューは複数の大きなインデックス付きテーブルなどを処理する際にパフォーマンスの問題の原因になる可能性があります。 編集1-あなたはすでにモデルレイヤーに分離されていると仮定しています

4
テキストの自動フォーマットを使用することをお勧めしますか?
私はEclipseを使用しており、例としてそれについてお話しますが、これは他のIDEにも当てはまると確信しています。 Eclipseは持ってCTRL- Shift- F自動的にあなたのコードをフォーマットするコマンドを。この種のフォーマットを使用するのは良い習慣ですか?多くのプログラマーが同じファイルで作業している可能性があり、これらはすべてCSVシステムで管理されている大きなプロジェクトのコンテキストでお願いしています。 ありがとうございました!

2
SQLコードをフォーマットするためのアルゴリズム
SQLコード(SQL Server / MySQL)をフォーマットする(社内で使用する)ツールが必要です。 それを実行するさまざまなサードパーティのツールとオンラインWebサイトがありますが、正確にどのようにそれを必要とするのかはわかりません。 したがって、自分のニーズに合った独自のツールを書きたいと思います。 最初の質問は、SQLコードをどのようにフォーマットするかについて、標準または規約がありますか?(私が試したツールは別の方法でフォーマットしました) 2番目の質問、このタスクにどのように取り組むべきですか?最初にSQLクエリをツリーのようなデータ構造に変換する必要がありますか?

3
コードのフォーマット:クラスファイル内の呼び出し階層に基づいて関数をレイアウトしますか?
ボブマーティンの「クリーンコード」からの提案により、頭が痛くなります。 これまでのところ、タイプ(プロパティ、アクター、関数)と可視性(パブリック/プロト/プライベート)によってクラスメンバーをグループ化する.Netガイドラインにほぼ固執してきました。チップは最初は問題があるようですが、「うまくいくかもしれません」。私は個人的に、このレイアウトが好きなケースに遭遇しました-適切なコールチェーンにいると、より簡単にドリルダウンできます。 ヒントの背後にある考えは確かに思えますが、「このクラスのパブリックインターフェイスを見てみましょう」などの他のシナリオはさらに悪化する可能性があります。たぶんボクルおじさんは小さなクラスとタイプを表示するためのIDEサポートに頼っています... 誰かが長期間これを試しましたか? 更新:コードスニペットが正しいようです class SomeType() { /// fields, ctors, et. all public void Method1() { // calls HelperMethod1 and HelperMethod2 } private void HelperMethod1 { // calls HelperMethod3 } private void HelperMethod3 {} private void HelperMethod2 {} public void Method2 () { // and so on... } }

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.