EngTW / English-for-Programmers

《程式英文》:用英文提昇程式可讀性
977 stars 45 forks source link

Count, Length, Size; 如何命名「容器、資料結構成員數量變數」? #4

Open twy30 opened 4 years ago

twy30 commented 4 years ago

例如說


什麼時候該用哪個字?該怎麼用?

LPenny-github commented 4 years ago

另一種面向,也許可以參考?

(from 《The Art of Readable Code》)

image

twy30 commented 4 years ago

@LPenny-github

這讓我想到,「命名」的 精練/精簡 與 脈絡 是息息相關的。

例如,對熟悉電腦領域的人來說, "file size" 指的幾乎就是「以 byte 計量的儲存空間」;也就是說, "size" 這個字只是個引子,引導讀者去連結它對電腦領域既有的知識、慣用術語。

最後就是看「預期的讀者是誰?它習慣的脈絡是什麼?」來決定要在「名字」中嵌入多少資訊。 🤔

LPenny-github commented 4 years ago

最後就是看「預期的讀者是誰?它習慣的脈絡是什麼?」來決定要在「名字」中嵌入多少資訊。 🤔

《The Art of Readable Code》在提及簡寫與否時,有提供一個標準(或許可參考?):

"So our rule of thumb is: would a new teammate understand what the name means? If so, then it’s probably okay.

For example, it’s fairly common for programmers to use eval instead of evaluation, doc instead of document, str instead of string. So a new teammate seeing FormatStr() will probably understand what that means. However, he or she probably won’t understand what a BEManager is. "

twy30 commented 4 years ago

同意。

而寫自己用的程式與寫 library/framework 的情形也不同;後者的受眾更大,對於 API 設計需要考量的事情更多 😅