コードをより標準化する方法

1.概要
このブログを書くとき、私も長い間考えていたので、異なる言語のコードスタイルを参考にして、最後に自分のコードをもっと標準的にする方法をまとめました.
2.基礎
Javaの基礎を例に説明します.

ファイル符号化フォーマットUTF-8

packageは最上位

に配置する必要がある.

importパケットの場合、eclipseのショートカットキー(command+1)を使用して対応するパケットを注ぎ込みます(パケットの順序を考慮する必要はありません)

フォーマットコードeclipseのショートカットキー(command+shift+f)を用いてフォーマットコード

を行う

if,else,for,whileなどの文は、空の

であっても括弧({})を付けなければならない.

コードブロックインデント、2つのスペース

を採用

列は120文字に制限、120文字を超える文や方法については再構築(読みやすく、コードの美観性)

を推奨する.

tabキーのデフォルトは4文字の長さ

です.
3.規範
コードを記述する際には、仕様に注意する必要があります.
論理判断を行う場合はelse文を追加する必要があります.else文が空であってもif文の後ろに追加する必要があります.

 1 public void getAppDetail(App app){

 2   

 3     if(app != null){

 4        //       

 5     }else{

 6        //          ，       ，      log

 7        log.info("App object is null");

 8     }  

 9     

10 }

switch文を書く場合、defaultはコードが何も含まれていない場合でも追加する必要があります.

switch(index){

    case 1:

              //        

              break;

    case 2:

              //        

              break;

    default:

              //         ，      

              log.info("Index is undefined");

              break;

}

コードブロックコメントを行う場合は注意が必要ですが、行は/*......*/、//を使用することもできます.複数行の/*...*/コメントについては、*から開始し、前の行の*と照合する必要があります.次に例を示します.

//     



/*      */



/*

 *   

 *   

 */

命名規則については、ネーミングを優雅にする方法を参照してください.
try...catch文を書く場合は、catch文では出力ログ情報(または異常を投げ出す)のみを設計し、ビジネスロジック処理をカバーしないことをお勧めします.

try{

    //       

    ......    

}catch(Exception e){

    //          

    log.error(String.format("Error message is %s",e));    

}



try{

    //       

    ......    

}catch(Exception e){

    //          

    throw new Exception();  

}

4.まとめ
氷の3尺は一日の寒さではなく、良いスタイルを身につけるには一朝一夕で完成することはできません.これは私たち自身が普段コードするときにこれらの細部に注意し、厳格に自分を要求する必要があります.亡羊は牢屋を補い,時は遅くない,特にこの博文を書いて,君と共に励ました.