跳到主要內容

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 來標示
出一些有問題而且壞掉的東西。

留言

這個網誌中的熱門文章

工程師跨越管理的第一道牆 - 放下

越來越複雜的網路應用 2022 年,網路應用越來越複雜,表層是 社群服務 ,轉頭看是 廣告服務 ,詳細看是 個資儲存庫 ,如此複雜的應用,如此眼花撩亂的系統架構, 現代的軟體開發已經從打個人戰,進入到團體戰鬥的打法。 打群架的時代 現在的許多產業,都在徵求軟體工程師,通常是徵求多位,以往以少少數量完成應用服務的時代已經過去。 現代已經是打群架的年代,前端至少一位,後端至少一位,系統管理,雲端管理等,這些都是在軟體公司內具備的職缺,已經很難回到那一人打天下的時代。 因此,誰能夠在技術領域中讓多種面向職能的人,互相進行協作,互相進行工作分配,將產品進度維持穩定產出,這樣的角色變得至關重要。 而通常,除了外部尋找此職能之外,這樣的職位,會以團隊中,最有技術力,且最能夠經常解決問題的人做為代表人。 帶領的第一課 - 『 放下』 相信大家都一定有聽過 彼得原理(Peter Principle) , 因其某種特質或特殊技能,令他被擢升到不能勝任的高階職 位,最終變成組織的障礙物 能力越強的人,通常被拔擢的越快,隨著職位的提升,也越發現能力的不適,而這問題在技術管理職位上特別常見。 因此,技術管理的第一堂課,要跟特別提醒的點是『放下』,特別是要放下自己的技術。 這可能與常理有所違背,為何會讓一個技術最強的人,去放棄他本身的技術呢? 放下的定義 放下,並不是要你放棄,癱軟在辦公室的椅子上什麼都不做,也不是讓你就捨棄掉對於技術的熱情,讓自己故步自封。 放下技術,是放下自己對於任何一種技術的直覺反應,本位思考,我們是否曾經聽過這種話 『如果是我來做,兩小時就可以完成了』 , 『這個很簡單,改一下就好了』 。 但今天,做的人不是你, 你已經進入管理者的角色 ,你已經被賦予 帶領的職能 ,帶領才是你該做的事情。 這時候如果以自己過往的 『經驗,效率,能力』 來看待 『他人』 的執行步驟及過程,會發現所有事情都如此的格格不入。 此時,你需要就是 『放下』 適當的放下自身技術能力 我們可能是因為自己曾經努力過,也可能自己剛好在那個時代,也可能是因為自己比較幸運,不論是哪一種可能,就是這麼剛好的在這個時間點成為 『帶人的那個人』 當我們用自己的眼光去看待所有人,看待所有新鮮人,就如同開著跑車去嘲笑騎摩托車的人不努

面試者如何挑戰大工程師時代來臨?

面試者如何挑戰大工程師時代來臨? 全世界都在倡導轉職成為工程師,似乎轉職成為工程師就成為職場的救贖,真的是如此嗎?讓老衲來杠給各位聽。 最近有位好久不見的小朋友,是 2000 年出生的小蔡,對於即將面臨到面對職場的挑戰開始關心起技術,他開始尋找比較適合自己的領域,同時也開始在思考到底為了接下來的就職小蔡該如何準備。 詢問我說是不是可以考慮軟體開發工程師這條路線 對於他的詢問,反而引起我的注意, 這讓我開始思考並映射於最近招募的經驗,軟體開發此領域是不是對於每個人都是可以擔任的職啀,這邊分享一些自己的看法希望對各位有所幫助。 全民工程師這件事情 在全球景氣低迷的狀況下,的確特別在這一年大家會很有感覺萬物齊漲,薪水不漲,薪資就是一直停滯不前。 很多時候,在不同的領域中,會發現整個薪資就算是擔任了管理職務主管你也會面臨到薪資的強大屏障在自己面前。 這個時候, 軟體工程師年薪百萬口號 似乎就成了一種救贖。 好像成為了工程師就可以達到年薪百萬,在家輕鬆工作,不用打卡也不用受到風吹雨淋,隨時想工作就可以工作,每個月又有固定薪水入帳,感受到類財富自由,人生的美好。 如果能夠爭取到跨國公司的職位,這份薪水有可能還可以上看每個月十多萬以上,甚至是往上也是極度有可能的事情,人生美好層次又再度提高了起來。 但這件事情是真的每個人都可以達到嗎? 還是這就是另外一種性存者偏差呢? 亦或者這些人其實是金字塔頂端的小眾? 每份履歷都像是同一種履歷 最近在最近幾年在面試工程師的時候特別會看到許多轉職者,一開始履歷裡面看到相關的作品一開始會覺得十分的驚艷, Wow, 現在的新手就可以做到如此精美的畫面,這些畫面是我當初用 Bootstrap 也做不出來的東西,許多的互動體驗好的一個不行,做出來的頁面配色和對齊也是極致。 但是隨著時間推移,多看了幾封履歷之後,就會發現在各大技術養成學院出來的學生履歷成果內容如出一轍,在面試的過程中也會詢問許多關於框架的底層概念,和比較技術觀念的時候,甚至是許多框架的核心概念,就很容易露出馬腳。 很多面試者會 一問三不知 ,透過許多引導,但殘酷的是連關鍵字是什麼都也無法推敲出來,更不用說在小組裡面到底怎麼樣合作,許多不同線上產品的比較,使用者流程,使用者後面的互動邏輯等,幾乎是風吹一片倒,只能

淺談 AI 落地到底有多難 - 以 OpenAI ChatGPT 為例

在 目前待領的團隊 ,小弟有幸 參與到 AI 落地的過程 ,之前也參與過幾次 AI 服務導入的和製作出 AI 產品應用的經驗,這邊就提出些簡單分享,跟大家說說,為何 AI 落地有這麼難 ChatGPT 幾乎成為這幾天大家刷版面的資訊,官方網站其實有提到 Chat-GPT 的參考模式是怎麼進行的,也有提供相關的論文參考, https://openai.com/blog/chatgpt/ ChatGPT 幾乎成為現象級的影響 如果你還沒試用過,我建議你真的玩玩看, https://chat.openai.com/chat 在 AI 落地的階段,有許多工程的過程,還有許多現實需要面對,而這煉成的過程都很容易導致 AI 落地失敗, 更不用說像是 ChatGPT 這種十年磨一劍的應用服務,為什麼驚艷, 中英文,簡中繁中等均能 80% 的機率識別問題及主題對話 回應內容,英文的部分不意外的通順,簡中繁中的部分有些詞語是有做過調整的,這實屬難得。 對於資料上下文關聯度,以及變化形式在主題式的發展下均能有效地回應且呈現。 呈現格式可以以『摘要、表格、條列』等方式進行規劃,同時也可以對文字內容進行一定程度的擴張和收斂。 而要做到這些事情,除了大家所熟知的需要不斷的生成模型,訓練模型,不同的模型疊加上去之外。 同時最難也是最複雜的部分, 『資料工程的處理』 AI 工程的開始 在我們使用任何一套 AI 框架 Tensorflow / pytorch 之後,無一例外地就會以特定問題解決方案,開始採用不同的現成 Model 進行驗證,在一開始對於初始的 example data / init data 都會有不錯的反應。 接下來問題開始... 當我們天馬行空的,不斷將例外,將特定領域情境涵蓋進去的時候,你就會發現這 model 的準確率下降,接下來就是一連串調整參數的開始, 或者是開始進行特例發想的部分,哪些資料是需要踢除的,哪些項目是需要先排開的,哪些資料是對於訓練本身是有影響的,在這個過程中就已經進入 data engineering 的環節中。 source from 資料科學家的工作日常 資料工程的處理 大家所想像的,在建立模型的時候似乎就是不斷地調參數,不斷的運作程式,但在這之前,有 『好多好多好多好多』