撰寫程式規則 Google Java Style Guide 紀錄

前言

10 個人寫程式,就會有 10 種風格出現。有一些基本的規定能讓大家參考,就不會造成後續要接手維護或臨時救火時,不知道該如何下手且也可以省去大量時間。

程式碼架構的清楚,參數和 function 定義的完整,當專案逐漸變得龐大時,後續要回過頭來再修改時,也可以更迅速的把問題或新功能補上。

下面是 Java 定義的 Code Style 有興趣可以參考

Google Code Style

If you want to view English version, you can check this blogger.

連結

介紹

整理幾個文件裡面有提到的內容

1. 空白的 function() 或 construct 大括號就不用再分段,有多個區塊的部分可以把括號換行

2. 單行最多字元 column limit : 100,這個不是絕對的限制.但若是一行程式碼太長,閱讀起來還是很不方便的.

秘訣 : 這邊提供一個方法,如果平常使用的筆電或電腦螢幕較小,需要把進度條前後移動來查看程式碼,可以到 Android Studio 去調整設定自適應螢幕大小,提升閱讀體驗也不會更改到程式碼的段落.

勾選紅框處,並加入指定檔案 .java 檔名

修改前

自適應螢幕

3. 命名的部分

3.1 packageName 以小寫為主且不加底線

correct        com.example.deepspace

Incorrect     com.example.deep_space, com.example.deepSpace

3.2 Class 名稱使用 UpperCamelName,開頭大寫且單字之間由大寫開始

For example : Character, DownloadTask

如果為測試使用可以在結尾加入 Test ,For example : DownloadTaskTest

3.3 Method 名稱使用 lowerCamelCase,開頭小寫且單字之間由大寫開始

For example : sendMessage(), cancelDownload()

4. 註解

個人觀點:
如果針對原先的程式碼修改了判斷的邏輯,可以加上註解寫明造成的原因及修改的方向,後續如果再發生問題時,也可以清楚了解這個部分曾經被修改過,因為很多錯誤都是在修改另外一個錯誤時,又額外產生出來的.且人的腦袋也沒辦法記住全部的程式碼,以及當初寫的時候流程是如何控制的,所以針對一些複雜的邏輯跟容易混淆的部分加上註解,可以幫助自己快速回想.

額外提出:
不確定是否所有專案或公司都允許在程式碼內加上註記.

後記

最直接的方法還是查看制式的專案在從裡面學習.英文也是一個重點,如果單字的詞彙量不多,那麼不管怎麼定義 function 或參數,就永遠都是那固定的幾個單字在流轉,如果有人可以討論從中獲得一些意見,那麼對自身能力的提升會更有幫助.

以下連結是 Github 上有提供的 Google Style Guide

Google Style Guide

最後文章中主要紀錄所見所學,如果文章中有什麼錯誤,請留言告訴我.

留言

熱門文章

2021申請 Android Developer 開發者帳號及上架步驟

Generate Signed Bundle / APK(s) & Bundle Tool 基本使用 & .aab安裝方式

40 個可以改變寫程式技巧的秘訣