跳到主要內容

Code Conventions for the Java Programming Language

it quote from http://java.sun.com/docs/codeconv/CodeConventions.pdf

Some chapter is very useful to me.
I am very appreciate a man who called "良格葛", translated this Document.

Chapter 9:

 命名慣例讓程式更容易被理解和閱讀。他們也可以給予關於識別子功能的
資訊 -- 例如,是否為常數,套件,或是類別 -- 這可以在瞭解程式碼時很有
幫助。

變數型態 | 命名規則 範例n-------------------------------------------------------------------------
套件   | 獨一無二的套件名稱的前置字都    com.sun.eng
     | 是使用所有都是小寫的 ASCII
     | 字母而且應該是頂層 DN 名稱,   com.apple.quicktime.v2
     | 目前有 com, edu, gov, mil,
     | net, org 或是 1981 年 ISO    edu.cmu.cs.bovik.cheese
     | 標準 3166 中用來辨識國家的兩
     | 字母碼。
     |
     | 接下來的套件名稱元件根據組織
     | 擁有的內部命名慣例而不同。這
     | 種慣例會指定某種被分隔的目錄
     | 名稱元件,部門,計畫,機器,
     | 或是登入名稱。
     |
     |
類別   | 類別名稱應該是名詞,由每個內   class Raster;
     | 部單字開頭字母皆為大寫的混和   class ImageSprite;
     | 字組成。試著讓你的類別名稱是
     | 個很簡單的敘述。使用整個字 --
     | 避免用頭字語或是縮寫 (除非縮
     | 寫比長字的形式被用的更廣泛。
     | 例如 URL 或 HTML)。
     |
     |
介面   | 介面名稱應該像類別名稱的大寫  interface RasterDelegate;
     | 法一樣。            interface Storing;
     |
     |
方法   | 方法應該為動詞,混和第一個字  run();
     | 母小寫和內部單字的第一個字母  runFast();
     | 大寫的狀況。          getBackground();
     |
     |
變數   | 除了變數之外,所有的實體,類  int  i;
     | 別,以及類別常數都是第一個字  char  c;
     | 母為小寫的混和狀況。內部單字  float  myWidth;
     | 則以大寫開頭。變數字不應以底
     | 線 _ 或是錢字號 $ 字元起始,
     | 就算這兩個都是被 Java 允許的。
     |
     | 變數名稱應該是短但仍有意義的
     | 。這變數名稱的選擇應該是幫助
     | 記憶的 -- 也就是說設計來讓不
     | 經意的觀察者都知道它使用的意
     | 圖。除了暫時使用後就被 "丟開"
     | 的變數名稱之外,應該避免使用
     | 單字元的變數。普遍使用的暫時
     | 變數名稱為用在整數的 i, j,
     | k, m, 和 n 以及用在字元的 e。
     |
     |
常數   | 宣告類別常數的變數名稱以及   static final int MIN_WIDTH = 4;
     | ANSI 常數的變數名稱應該是以  static final int MAX_WIDTH = 999;
     | ("_") 底線分隔的全大寫字。(  static final int GET_THE_CPU = 1;
     | 為了易於除錯,應該避免 ANSI
     | 常數。)
     |

Chapter 10:

10.1 提供實體變數和類別變數的權限
1
2
3
4
5
6
7
  沒有好理由的話,不要讓任何的實體變數或是類別變數是 public 的。通常
,實體變數不需要被直接的設定或是獲得 -- 通常是作為方法呼叫的邊際效
應。

一個適當的 public 實體變數的例子是當這個類別是一個沒有行為的基本的
資料結構時。換句話說,如果你可能會使用 struct 來代替類別的話 (如果
Java 支援 struct 的話) ,那讓類別的實體變數是 public 就是適當的。

10.2 引用類別變數和方法
1
2
3
4
5
6
  避免使用物件來存取類別(static)變數和方法。使用類別名稱來代替。例如


classMethod(); // OK
AClass.classMethod(); // OK
anObject.classMethod(); // 避免!

10.3 常數
1
2
  會出現在 for 迴圈中當作計數值的數值常數 (直譯
字) ,除了 -1,0,和 1 之外,不應該直接編寫。

10.4 變數指定
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
  避免在單一敘述中指定好幾個變數為同一個值。那會不容易閱讀。例如:

fooBar.fChar = barFoo.lchar = 'c'; // 避免!

不要在可能很容易會跟相等運算子搞混的地方使用指定運算子。例如:

if (c++ = d++) { // 避免! ( Java 不允許)
...
}

應該寫成

if ((c++ = d++) != 0) {
...
}

不要為了改善執行效率而使用嵌入式的指定。這是編譯器的工作。例如:

d = ( a = b + c) + r; // 避免!

應該寫成

a = b + c;
d = a + r;

10.5 雜項慣例

10.5.1 小括號
1
2
3
4
5
6
  在表示式中包含了混和的操作子時,使用大量的小括號來避免優先權的問題是
一個不錯的作法。即使操作子的優先權對你來說看來很清楚,對別人來說可能
不是如此 -- 你不應該假設其他的程式設計師對優先權的瞭解跟你一樣好。

if (a == b && c == d) // 避免!
if ((a == b) && (c == d)) // 使用

10.5.2 傳回值
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
  試著讓你程式的架構符合意圖。例如:

if (booleanExpression) {
return true;
} else {
return false;
}

應該以下列取代

return booleanExpression;

相同的,

if (條件) {
return x;
}
return y;

應該寫成這樣

return (條件 ? x : y);

10.5.3 在條件運算子中 "?" 之前的表示式
1
2
3
4
  如果在 ?: 運算子的 ? 之前出現的表示式中包含了二元運算子,那它應該被
小括號刮起來。例如:

(x >= 0) ? x : -x;

10.5.4 特別註解
1
2
  在註解中使用 XXX 來標出一些假的但是仍有用的東西。使用 FIXME 來標示
出一些有問題而且壞掉的東西。

留言

這個網誌中的熱門文章

[分享] 腳踏車環島注意事項

很多人都期望自己能夠做點什麼,做些什麼,而退伍之後的第二個星期,就展開了環島之旅。

對很多人來說這不算什麼,甚至有人展開了走路、跑步、溜滑板、單輪車等方式環島一周,充分展現對台灣的愛與關懷。

這篇主要讓不知道怎麼準備環島的人,作一個完善的解說,首先隨身的東西要有:

證件現金類
身份證健保卡學生證現金提款卡悠遊卡

館長的網站技術瓶頸,小弟弟來解答 - notorious-2019.com

館長的網站技術瓶頸,小弟弟來解答 - notorious-2019.com昨天看到館長的網站倒了,也看到館長說一個月花費大概一百萬左右的月費在支持這個架設的電商網站,也對外發布出來訊息,希望求救,直接講結論建議解法,1. 首先要做的事情是讓整個網站可以橫向擴展 (Load Balancer + n 台伺服器),對,相信我,IIS 也是可以做 Scale out, 這是對於 Application layer 服務的解法。2. 資料的部分 SQL 吞吐量,建議改成 GCP Cloud SQL, 或者就直接轉到 Azure SQL Server 環境上會相對容易解決 SQL 的問題。上述 2 個步驟都處理完,其實 100 萬的費用,應該 20000 concurrent user 是沒有問題的,但前提是要設定『對』!額外需要花較長期時間要處理的,建議就是在 Queue 的處理,購物車的狀態都可以進入到 Queue 再來處理 SQL insert 的問題,減少不斷的 insert / update 的狀態,後文會提到 ...底下詳細的會再說明如何後後續還有哪些處理的細節。這兩天剛好有個小空擋,就來分析一下狀況,可以從外部讀取得到的服務大致上如下,ASP.Net: 4.0IIS 10 + Windows (廢話)SQL Server (推測)OP Service: PleskWinHost: Google CloudDNS: Cloudflare前端服務內容架構Server-side render, jQuery base, 推測有可能採用現成購物車來進行,看起來不太像是用 wooCommerce 比較像是 Cart Functionality 這類的項目直接搭建而成(當然這純屬猜測)功能拆解因為網站是透過 Server site render 所有頁面都需要重新透過伺服器進行載入,這樣的狀況,如果在頻繁忙碌的 eCommerce 網站架構下會是一個致命傷,簡單來說,數量的查詢,特惠價,優惠碼等等資訊的處理,使用者每做一步都需要重新跳轉頁面,或者整頁面重新讀取,只是為了部分的資料更新,這些都可以抽取出來成為 API ,透過 AJAX 的方式進行讀取。讀寫分離在不了解目前資料庫複雜狀態下,首先要讓所有人都可以讀取到資料,頁面可以跑出來,建議至少將讀取資料庫,和寫入資料庫的…

Scrum management tool 敏捷開發工具概觀介紹

Scrum management 工具概觀介紹
會有這個念頭興起主要也是因為這幾個月內,是在公司內部訓練透過 Teddy 老師 Scrum 課程了解整個 Scrum 的流程,開始進行團隊的 Scrum 流程導入。

在過年春節期間去嘗試市面上的 Scrum 管理軟體,也透過眾多大大得到解答

這邊就不詳細討論怎麼進行 Scrum 的軟體開發,而是在於管理機制,就整個流程上,對於自己需要的項目有,
SprintUser Story (Backlog)Task management task time countertask assigneeburndown chart 以上這幾個是在 Scrum 流程裡面最基本的需求以及解法,而根據大量搜尋結果,也找到許多不同平台,以下為個人分析經驗,
trello.comhttps://trello.com/ 一開始很直覺的就會採用到 Trello ,而經過測試後,如果直接的使用 trello 是沒有辦法達到以上的所有方法,必須要結合,scrum for trello ,所以也表示如果你的電腦沒有安裝 Chrome的話,勢必就是 GG
的確這是一個假命題,身為一個開發者,或者前端人員怎麼可能沒有 Chrome ,(也許真的沒有),不過比較麻煩的是,雖然 trello 加上套件後可以管理 Task, time counter, burndown chart 都有支援,但是通常一個 Sprint 會有兩到三個 User Story ,所以對於 task 橫向管理對應 User Story 是比較麻煩的。
taiga.iohttps://taiga.io/ Taiga 也是許多人推薦的一套管理系統,就整體表現以及流程上,的確沒有像是 trello 這麼順暢,不過從另外一個方面來看,他是完全 open source ,而且可以 self host 這點來說,的確是非常適合用於自己的敏捷專案管理上,這點的確可以說是開源軟體的轟炸機。

不過就回到 Scrum 管理層面來說,畢竟人家 taiga 開宗明義就說了,流程上是符合于 kanban ,所以缺少了 task time counter 的部份,也沒有 User story 管理。所以回到 Scrum 本身,Taiga 就並不是這麼適合。
blossom.iohttps://www.blo…