Re: [閒聊] 寫code不加註解真的很顧人怨嗎

nh60211as12/25 21:06首先算錢用浮點

strlen12/25 21:07反對者很多 而且還很大一部份是不學無術的老屁股冗員

strlen12/25 21:07因為寫clean code很麻煩 很燒腦 很吃力不討好 懶啦

arrenwu12/25 21:07原來寫在 function 前的comment還有特別稱呼啊XD

Ratucao12/25 21:10西洽點在哪

enmeitiryous12/25 21:10所以是建議用大寫區隔函式內的詞而不是底線嗎

pride82912/25 21:10我知道算錢有更好的方式，但我不想加入太多東西讓這篇

pride82912/25 21:10文章對新手來說更難懂

Tokukenis12/25 21:11推文件導向

eva05s12/25 21:12回文不用點

arrenwu12/25 21:12回文不是不用點 而是沒有洽點的話要跟引文有關係

pride82912/25 21:12命名風格通常是根據程式語言跟你的團隊來做決定，以這

pride82912/25 21:12篇文來說是Java

arrenwu12/25 21:13這篇顯然是跟引文有關的

qwer33885912/25 21:16回文又不用點 鬼叫什麼

Richun12/25 21:16前面的那個不完全是comment，有的說法是doc string。

Richun12/25 21:17像是Python有"""開頭"""結尾可以寫整串的東西能用。

kaj198312/25 21:17總之好懂的寫法就是對的，想辦法寫出好懂的程式也是對的

arrenwu12/25 21:17我一直以為這些都叫做 comment XDDD

kuninaka12/25 21:17這篇是正確的，可以自我註釋的程式碼才好讀

Richun12/25 21:18Rust有///開頭的東西，編譯同時可以輸出成文件。

sunshinecan12/25 21:18推這篇

kuninaka12/25 21:19我現在常常只寫註解就讓GenAI跑程式出來

Richun12/25 21:19如果函數切分得好，函數名稱本身就是一個好的註解了。

h010366112/25 21:19算錢也不能用浮點，用decimal才能避免小數點問題

spfy12/25 21:20很多語言甚至不同TEAM的規範都不同吧 這我倒是覺得統一就好

kuninaka12/25 21:20大寫區隔函式內的詞??

kuninaka12/25 21:20你是想說 camel case ??

qwer33885912/25 21:21每個語言基本代碼風格規範不同這看起來是C#

kuninaka12/25 21:21這是JAVA阿

arrenwu12/25 21:22C/C++ 是不是也是這個樣子啊？

qwer33885912/25 21:22真的欸 那他在說什麼大寫

Richun12/25 21:22C#的命名風格是函數PascalCase，區域變數才用camelCase。

arrenwu12/25 21:23這個變數命名那個自己組裡面講好就好了 然後寫的時候看

arrenwu12/25 21:23一下有沒有跟旁邊的code長得太不一樣XDDD

Richun12/25 21:24推文應該只是不知道code style，那個各語言習慣差很多。

kuninaka12/25 21:24反正不要用奇怪的縮寫或沒意義的詞就好

kuninaka12/25 21:24有看過初學者用ABCDEFG來命名XD

Richun12/25 21:25editorconfig解決縮排問題，coding style各語言各有工具。

kuninaka12/25 21:25現在寫程式比以前好太多了，AI太強

Richun12/25 21:26聽說打競賽的為了拚那幾秒，會用abc跟ijk這種免洗命名法XD

D12212/25 21:26變數名不要取太差就還好 真的

spfy12/25 21:27https://i.imgur.com/QdO4bqq.png

spfy12/25 21:28有些26會用漢語拼音+縮寫=通靈命名法

h010366112/25 21:29y1s1 對岸應該很習慣

shadow032612/25 21:30我一直想知道中國工程師寫int64會不會過不了審

k96060812/25 21:31不會 小學生看不懂

kuninaka12/25 21:3226那邊真的很多拼音縮寫的智障命名法= =

pride82912/25 21:32變數如何命名也是個大坑，一般來說你的視野（scope）越

pride82912/25 21:32大，名稱就要越長，反之則最短

kuninaka12/25 21:32scope很大，名稱很短會死人阿XDDD

greatloser12/25 21:335樓菜雞還特別大聲

arrenwu12/25 21:34所以一般會用namespace保護啊

Richun12/25 21:48但C沒有namespace，不是在.c能用static藏的函數得很臭長。

arrenwu12/25 21:50沒有 namespace ... 好ㄅ

spfy12/25 21:54原來如此

XFarter12/25 21:55其實大家指的「必須要存在的」 comment 就是原 Po 的 doc

XFarter12/25 21:55ument 吧

XFarter12/25 21:55只是好像不是每個人都會這樣稱呼它，甚至我也只在 clean

XFarter12/25 21:55code 以及一些軟工討論才有機會看到這樣的稱呼

XFarter12/25 21:57C 因為沒有 namespace 所以 scope 更顯得重要就是了。幸

XFarter12/25 21:57好還是有 struct 這種基本的能用

spfy12/25 22:01VS有內建的註解系統能搭配PLUGIN輸出成程式說明文件

spfy12/25 22:02但認真寫會變成CODE以外一大堆又臭又長的XML註解 所以官方

spfy12/25 22:03又建議你用另一個特殊的XML NODE把整份XML註解移動到一個獨

spfy12/25 22:03立的XML檔案 然後程式碼只要指過去就好 但不知道有多少人真

spfy12/25 22:04的有用這套XML註解功能產整份文件...

AnyonRedira12/25 22:11推 clean code

wulouise12/25 22:29對，你全部都重寫當然沒問題

silveryiris12/25 22:46推

fman12/25 23:00我自己經驗，一個禮拜這隻code就不認識了，有過看code覺得這

fman12/25 23:00個人寫的不錯，想法和我差不多，再看作者，靠北，不就是我自

fman12/25 23:00己，還上禮拜寫的 XD 忙的時候特別容易發生這種事情

lylu12/25 23:23現代螢幕都夠大了取名長一點沒什麼問題 取很簡短又重複的在

lylu12/25 23:23大型專案裡面搜關鍵字會很火

Galbygene12/25 23:35推

n002948030012/25 23:36同意這篇

ptt021112/26 00:14算錢用浮點 遲早被人扁

tacodrem12/26 00:56同意文件的優先重要性

tacodrem12/26 00:56但如果遇到寫文件就像要他命的團隊...

tacodrem12/26 00:56摸摸鼻子寫好ITS備註跟註解存證據比較快= =

CP6412/26 01:02c 姑且算是有 ns 啦 只是人家的 ns 是劃在 compile unit 上

melancholy0712/26 01:02推

melancholy0712/26 01:02推

CP6412/26 01:03所以會有那種同一個元件有兩個 header 一個內用一個外帶

shallreturn12/26 01:42clean code 明明就蠻簡單的 講白了用代碼講清楚自己

shallreturn12/26 01:42的代碼在幹嘛

chrisjeremy12/26 02:18文件跟註解有一樣的問題 程式碼改了 功能有變化 文件

chrisjeremy12/26 02:18不見得會更新 是說連註解都沒改了 文件更不會改

chrisjeremy12/26 02:19但是寫文件跟維護文件很重要我舉雙手同意

chrisjeremy12/26 02:21只是時程上往往沒有足夠的時間去維護文件

MK4712/26 04:25推這篇 沒有code review已經夠怪了 連規範都沒有 不知道那種

MK4712/26 04:25公司在幹嘛

choosin12/26 07:41基本上文件先行 就沒有維護來不及的問題 再來就是如這篇

choosin12/26 07:41所講 別誤用註解