跳到主要內容

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

留言

這個網誌中的熱門文章

RAG 和 Prompt 原理超簡單解說!想知道 AI 怎麼找答案看這篇

這篇文章是給對於你已經開始使用所謂的 ChatGPT / Claude / Gemini 之類的 AI 服務,甚至是 Siri (嘿丟,他也是一種 AI 應用服務喔) 簡單來說是非 技術人員, PM,小白,想要趕快惡補的人 ,直接花十分鐘可以看完的一篇科普業配文章。 或者是概念僅止於,AI 這東西會幻想,會有誤差,會對於生活有些幫助但沒有幫助的人們,做個簡單又不是太簡單的介紹,希望用一個非常入門的方式讓你們有個了解。 當然,這篇文章目的很簡單, 就是引流 ,如果你身邊有已經對於 Web 技術開發的人員,歡迎報名分享給他,年末出國不如學一技在身,參加今年我們舉辦最後一場 RAG 實作工作坊,報名連結 , https://exma.kktix.cc/events/ai-for-dev-course-rag-2 注意: 接下來每個大段落結束都會有一段工商導入,但文章絕對精彩,請注意! 為了讓各位容易想像,我們將整個世界的資訊,先濃縮到這本『西遊記』的世界觀當中,我們整個世界都在這個 『西遊記』 ,而 大型語言模型 我們用 『書精靈』 來描述。 PS. 我們先預設各位,應該都有聽過,西遊記!如果沒有聽過西遊記的,請右轉出去,謝謝! 先來談談向量 在《西遊記》的世界裡,我們可以把 向量想像成一種「內容座標」 ,讓系統知道每個角色、場景、法術等的 「位置」和「距離」 。向量幫助語言模型知道不同內容之間的關聯程度。 向量就像內容的「距離」和「位置」 比方說,唐三藏的 「位置」(向量)會接近「佛經」和「取經」 的概念,因為他一路上都是為了取經而前進。孫悟空的 向量位置則會更靠近「金箍棒」和「七十二變」 這些概念,因為這些是他的特徵。 相似內容靠得更近:像「佛經」和「取經」會靠近唐三藏的向量,因為它們彼此有很強的關聯。 相差較大內容會離得較遠:像「取經」和「妖怪」「妖怪的寶藏」就距離比較遠,因為妖怪的寶藏和取經的目標關聯性不大。 是誰決定的這些位置? 簡單來說,這些位置和關係是模型自己學出來的。語言模型會閱讀大量的資料和這世界觀的資訊,觀察哪些詞語經常一起出現,根據「共同出現的頻率」來決定它們的關係,並且自動生成向量。例如: 如果模型看到 「唐三藏」 總是和 「取經」 一起出現,它就會讓「唐三藏」的向量靠近「取經」。 ...

Vibe Coding:為什麼 Junior 更快上手?Senior 要如何追趕?

現象層面(市場觀察) 最近有篇文章討論 junior & senior 開發者在 AI 時代的角色轉變,非常熱門。 身為 Cympack 產品開發團隊 ,我們也一直關注這個議題,在閱讀這篇文章時觀察到一些有趣的現象,對我們來說,這正好反映出 AI 正在改變開發生態,junior 借力 AI 快速成長、senior 則需要在 「架構思維」 與 「多 agent 協作」 中找到新定位,其中有些啟發(insight) 可以跟大家分享。 為什麼 Junior 更容易上手 vibe coding? 心智負擔低 → Junior 沒有太多傳統 code workflow 的框架包袱 敢於嘗鮮 → Gen Z / 年輕工程師天生習慣用 prompt-based 工具、跟 LLM 互動 少「優雅程式設計」的束縛 → 不太糾結「這樣寫會不會不夠優雅」,反而 embrace 快速迭代、快速出成果 反觀 Senior: 熟悉大型系統設計 有豐富的「工程正統流程」知識(架構設計、測試策略、效能優化、設計模式) 對 AI 生成 code 的品質 / 維護性通常比較保留 部分 10+ 年資深工程師,對 prompt engineering 沒那麼熟練,還在觀望 技能面(未來的關鍵能力) Vibe coding 本質上 = prompt engineering + AI co-pilot 管理能力 能力項目 誰目前比較有優勢? Prompt 撰寫 / AI 互動 Junior 較強(熟悉 chat-based 流程) 系統設計 / 架構把關 Senior 較強 AI 生成 code 驗證 / Bug 察覺能力 Senior 較強(能看出潛在問題) 快速疊代 / Hackathon 式開發 Junior 較強 長期維護性 / 穩定性 Senior 較強 總結 Junior 確實更快適應 vibe coding,並且更習慣以 「chat-based coding」 的工作流開發。 Senior 擁有驗證 AI 產物與系統設計的深度能力,但若不主動練習 vibe coding,長期會逐漸落後於新一波開發潮流。 就如同在 GAI 技術年會分享,希望帶給各位的感受, 『與 AI 協...

v0 API 是什麼?怎麼用?一篇教你搞懂功能、價格,還能搭配 Cursor 玩出 vibe coding!

Vercel 的 v0 是一款 AI 驅動的前端開發工具,能夠將自然語言描述轉換為可部署的 React 元件和 UI 介面,支援 Tailwind CSS,並可直接部署至 Vercel 平台。此外,v0 提供 API 介面,讓開發者能將其整合至其他工具,如 Cursor IDE,進一步提升開發效率。 Vercel v0 API 介紹 v0 API 目前處於 Beta 階段,主要提供 v0-1.0-md 模型,具備以下特點: 多模態支援:接受文字與圖片(base64 編碼)輸入。  快速串流回應:提供低延遲的串流回應。  OpenAI 相容:遵循 OpenAI Chat Completions API 格式,易於整合至現有工具。  前端開發優化:特別針對 Next.js 和 Vercel 等現代前端框架進行優化。 要使用 v0 API,需訂閱 Premium 或 Team 方案 ,並啟用使用量計費。 使用方式 API 端點: POST https://api.v0.dev/v1/chat/completions 請求標頭: Authorization: Bearer YOUR_V0_API_KEY Content-Type: application/json 參數範例: { "model": "v0-1.0-md", "messages": [ { "role": "user", "content": "建立一個具有身份驗證功能的 Next.js AI 聊天機器人" } ], "stream": true } 您也可以使用官方的 AI SDK 進行整合: npm install ai @ai-sdk/vercel 範例程式 javascript import { generateText } from 'ai'; import { vercel } from '@ai-sdk/vercel'; const { text } = await generateText({ model: vercel...