作者Byzantin (拜占庭)
看板Soft_Job
標題[請益] 註解的風格
時間Fri Dec 18 19:20:57 2015
請問一下各位
有在註解裡寫上自己的名字的習慣嗎?
我們有在使用git, 哪段code是誰寫的很容易知道
我自己覺得不太需要註解說是誰寫的。
請問大家對這樣做法的看法是
謝謝
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 123.51.170.59
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1450437660.A.A21.html
1F：推 sunkai329: 要看誰寫的話，可以 git blame，不用特別註解吧XD 12/18 19:26
2F：推 discoby: 那是過去遺留的習慣吧 意義已經不存在了 12/18 19:27
3F：推 sing10407: 接手別人的專案，之後可能不是自己修改的會 12/18 19:29
4F：→ YahooTaiwan: 完全不用寫 版控一查一清二楚 12/18 19:36
5F：→ bbser: Let codes talk,還要寫註解表示程式還有改善空間。 12/18 21:01
6F：推 GoalBased: 加名字要幹嘛 12/18 22:53
7F：→ Killercat: 有VCS寫註解名字真的沒啥必要，除非你用的是類似P4 12/18 23:12
8F：→ Killercat: 那種branch merge會造成不容易blame到人的vcs以外 12/18 23:12
9F：→ Killercat: 其實多半沒必要再寫名字了 12/18 23:12
10F：→ s860134: 舊一點的程式設計書籍都會說這是好習慣XD 12/19 00:44
11F：→ swordsun: 會簽名的是人家給你方便,還嫌囉嗦,嘖嘖嘖.... 12/19 00:51
12F：→ qweqweqweqwe: 以前會，但後來發現只會造成閱讀上更大的困難而已， 12/19 01:39
13F：→ qweqweqweqwe: 況且有 git 可以看，後來看更多書後發現，甚至還有 12/19 01:39
14F：→ qweqweqweqwe: 些 refactor 的書建議連註解都不要寫…其實蠻有道理 12/19 01:39
15F：→ qweqweqweqwe: 的，多數人改程式碼都不會改註解，一年後註解跟程 12/19 01:39
16F：→ qweqweqweqwe: 式碼根本嚴重脫鉤 12/19 01:39
17F：推 iWRZ: 前人種樹 後人砍樹 臺灣軟工 莫莫默默 12/19 01:43
18F：→ pest: TODO 旁邊加名字 然後寫個git plugin定期提醒 XD 12/19 05:22
19F：推 cobrasgo: let codes talk也是要看狀況的，driver的東西不寫註解是 12/19 10:19
20F：→ cobrasgo: 要我來查datasheet嗎 12/19 10:19
21F：推 cobrasgo: 還有protocol相關的code也是，不寫註解的話可讀性通常 12/19 10:24
22F：→ cobrasgo: 很差 12/19 10:24
23F：推 cobrasgo: 會武斷的說不需要註解的人我不知道你有沒寫過driver 12/19 10:25
24F：推 cobrasgo: 另外linux kernel裡一堆為了優化的組語，不寫註解跟天 12/19 10:28
25F：→ cobrasgo: 書一樣 12/19 10:28
26F：推 chuegou: 推樓上 12/19 10:37
27F：推 guest0710: 試情況還是要加吧 程式活的比git怎麼辦… 12/19 11:51
28F：推 guest0710: 啊 我是只寫一般註解部分 名字絕對不放XD 12/19 11:53
29F：→ qweqweqweqwe: 那可能是因為小弟沒碰過 driver 的部分，書也是java 12/19 12:27
30F：→ qweqweqweqwe: base 的關係吧 QQ 看來還是要照不同的情況服用 12/19 12:27
31F：→ qrtt1: 就算寫 java 你實在特殊的演算法還是得加註解， 12/19 13:01
32F：→ qrtt1: 寫寫 reference 或選用公式在裡面啊。 12/19 13:02
33F：→ manaup: 有些code無法說明的通靈事件會寫註解喔 12/19 13:09
34F：→ manaup: 像是"xxx user 改了又改 改又改 第7版改回第2版效果"這種 12/19 13:10
35F：→ manaup: "yyy PM特別要求的腦殘功能 預計UAT時會被打槍拿掉" 12/19 13:12
36F：→ manaup: "20081223 Xmas前趕時程技術積 以後有時間再finetune" 12/19 13:12
37F：→ manaup: "It's magic. 它會動,還沒有人搞懂為什麼.勿修改" 12/19 13:14
38F：→ manaup: "這package相關設計和程式是用香蕉買來的" 12/19 13:21
39F：推 humanfly: 不確定的我會留名啊，說明原因，sourcesafe+2008要找誰 12/19 13:51
40F：→ humanfly: 寫的頗麻煩 12/19 13:51
41F：推 vn509942: 反正註解區塊可以收起 不影響閱讀 12/19 14:02
42F：推 YahooTaiwan: 不是 "不用寫註解"，而是 "不用寫作者名" 12/19 15:22
43F：→ YahooTaiwan: 只有自己看得懂的演算法或 Protocol 當然要註解 12/19 15:23
44F：推 YahooTaiwan: 我還以為本文第二行是在問大家要不要寫作者名欸 12/19 15:25
45F：推 Ekmund: 我會 而且我會在註解裡寫髒話跟語助詞 12/19 20:20
46F：→ GoalBased: 這證明了中文很難，只有六行還是很難抓到重點 12/19 22:51
47F：推 YahooTaiwan: 也證明了，會寫程式跟邏輯好壞與腦袋清不清楚無關 12/19 23:04
48F：推 abc0922001: git blame就可以找出哪一行誰寫的了 12/20 00:19
49F：推 cobrasgo: 人家在針對推文又不是本文，自打臉很爽嗎 12/20 11:25
50F：推 MelLynce: 請問是否有編輯器可以方便地 將各行的歷來各版git blame 12/20 12:04
51F：→ MelLynce: 資訊秀出？ 12/20 12:04
52F：推 YahooTaiwan: 我打得是你的臉嗎？這麼急著跳出來幹麻？ 12/20 13:08
53F：推 YahooTaiwan: 中文真的有這麼難理解嗎？ 12/20 13:13
54F：噓 see7di: 沒必要談的話題，打醬油路過 12/20 14:23
55F：→ aa000017: manaup大大講的我也寫過XD 12/21 13:00
56F：推 cobrasgo: 人家在推文新開主題，中文真的有這麼難理解嗎？ 12/21 16:37
57F：→ cobrasgo: verified, case closed 12/21 16:37
61F：推 YahooTaiwan: 你開新主題就開新主題阿，請問我酸的是你嗎?? 12/21 21:05
62F：推 commonccc: 會寫名字 冤有頭 債有主 哈 12/25 19:52