[5章]フォーマットの調整

フォーマットの目的

コードフォーマットはコミュニケーションの一部であり、重要すぎるため盲目的に従うのは1006172です.

目的はコードの可読性を高めることです!
可読性↑→コード品質↑

適切な行間を保つ

👉🏻 一般的に、小さなファイルは大きなファイルよりも理解しやすい.
👉🏻 200行程度がおすすめです

1.新聞記事のように書く

ニュース記事:タイトル→全文を要約する最初の言葉→詳細

ソースファイルも同じ!
1)名前はわかりやすく、
2)ソースファイルの第1部は高度な概念とアルゴリズムの説明である
3)下がれば下がるほど詳細に意図を説明する
4)最後に最下位レベルの関数と詳細

2.概念を空行に分ける

一連の行束は完全な考えを表している.

の考え方の間に空行を加えて概念を分離しなければならない.

EX)<パッケージ宣言><インポート文><各関数>

3.縦密度

歳、密集度は関連性を意味する.

相互に緊密なコード行は垂直に近づくべきである.

の無意味な注釈で縦密集度規則に違反しないでください.

4.垂直距離

相互に密接な概念は、1つのファイルに縦に近づくべきである.

変数は、可能な限り使用位置に近づきます.

インスタンス変数は、クラスに最初に作成されます.

依存関数は垂直に近く、呼び出すことができる関数は最初に配置されます.

概念上の類似性、概念上の親和性が高いほど、コード配置が近い.

5.縦の順序

通常、関数呼び出し依存関係は下に維持されます.

ソースモジュールは、高レベルから低レベルに自然に低下します.

水平書式

👉🏻 大半は20~30字、45字近くで、著者が推薦した頭取は120字程度に制限されている.

1.横余白と密集度

街は、密接な概念と緩やかな概念を表現するために空白を使用する.

スペースを加えると、主な要因を特定できます.
EX)付与文、括弧内引数、演算子優先度ハイライト

密接な要因は空白を残さない.
EX)関数名に連用する括弧

2.水平揃え

❌

は、特定の構造を強調するために使用される.

セグメントでは、コードが誤った部分を強調する可能性があり、真の意図を隠すことができ、コードソートツールはこれらを無視することができます.

その利点は、

が逆にソートされていない場合に重大な欠陥を見つけやすいことである.

3.インデント

⭐️

のインデントの程度は階層の収入レベルに比例している.

クラス定義のように、ファイルレベルの文章は書かない.

4.偽範囲

空のwhileドアまたはforドアを避けることができない場合は、新しい行にセミコロンを正しく記入してください.

while(dis.read(buf,0,readBufferSize) != -1)
;

チーム・ルール

チームに属している場合は、自分のルールではなくチームルールを選択する必要があります.

一般的なカッコ

の位置、インデント、クラスおよび変数、メソッド名ルールなどについて説明します.

デザインは一貫して滑らかでなければなりません.

印象的な...

プログラマー一人一人が好きなルールを持っています.しかし、チームに属している場合は、選択すべきルールはチームルールです.
良いソフトウェアシステムは読みやすいドキュメントから構成されています.デザインは一貫して滑らかでなければならない.