編碼規範

• 註釋
• • • Pycharm：
    • IntelliJ IDEA：
• 命名
• • • Python
    • Java
• IDE整合程式碼檢查外掛

註釋

對於模組，類，方法，甚至於某一步驟的演算法，處理都需要進行功能註釋，邏輯註釋，對於註釋可以採取一個統一的標準。

• 檔案開始使用塊註釋表明檔案實現功能
• 每個類，方法，或者演算法之前使用行註釋標明功能，超過一行的話使用塊註釋

Pycharm：

塊註釋：選中該行，ctrl+/
單行註釋，鍵入三個單引號’‘’後用回車Enter補全
函式註釋：函式定義下面鍵入三個單引號‘’‘後回車Enter補全

IntelliJ IDEA：

單行註釋：選中該行，ctrl+/
塊註釋：鍵入/*後用回車Enter

命名

Python

• 包，模組 都是小寫字母，不允許下劃線
• 類，首字母大寫
• 方法，變數名 全部小寫字母，允許下劃線連線

Java

• 包，全部小寫字母，頂級域名
• 類，首字母大寫
• 方法名 動詞，駝峰原則
• 變數名 駝峰原則

IDE整合程式碼檢查外掛

• Pycharm 自帶autopep8外掛，可以在Code，Reformat中直接格式化程式碼，快捷鍵Ctrl+Shift+Alt+L
• IDEA設定中Plugins中整合Alibaba Java Coding Guidelines 阿里巴巴編碼規範：
  • 單個檔案，右鍵，執行編碼掃描規範
    
  • 模組掃描，選中模組，執行編碼掃描規範
    ，在控制檯中輸出結果 建議對語言有一定熟悉之後再開啟這個功能，否則一堆報錯是很頭疼的，同樣可以用快捷鍵Ctrl+Shift+Alt+L格式化程式碼