回看板
Disp BBS
看板 Soft_Job
作者 Byzantin (拜占庭)
標題 [請益] 註解的風格
時間 Fri Dec 18 19:20:57 2015

請問一下各位

有在註解裡寫上自己的名字的習慣嗎?

我們有在使用git, 哪段code是誰寫的很容易知道

我自己覺得不太需要註解說是誰寫的。

請問大家對這樣做法的看法是

謝謝

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 123.51.170.59
※ 文章代碼(AID): #1MS-mSeX (Soft_Job)
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1450437660.A.A21.html
推 sunkai329: 要看誰寫的話，可以 git blame，不用特別註解吧XD1F 12/18 19:26
推 discoby: 那是過去遺留的習慣吧 意義已經不存在了2F 12/18 19:27
推 sing10407: 接手別人的專案，之後可能不是自己修改的會3F 12/18 19:29
→ YahooTaiwan: 完全不用寫 版控一查一清二楚4F 12/18 19:36
→ bbser: Let codes talk,還要寫註解表示程式還有改善空間。5F 12/18 21:01
推 GoalBased: 加名字要幹嘛6F 12/18 22:53
→ Killercat: 有VCS寫註解名字真的沒啥必要，除非你用的是類似P4
那種branch merge會造成不容易blame到人的vcs以外
其實多半沒必要再寫名字了7F 12/18 23:12
→ s860134: 舊一點的程式設計書籍都會說這是好習慣XD10F 12/19 00:44
→ swordsun: 會簽名的是人家給你方便,還嫌囉嗦,嘖嘖嘖....11F 12/19 00:51
→ qweqweqweqwe: 以前會，但後來發現只會造成閱讀上更大的困難而已，況且有 git 可以看，後來看更多書後發現，甚至還有些 refactor 的書建議連註解都不要寫…其實蠻有道理的，多數人改程式碼都不會改註解，一年後註解跟程式碼根本嚴重脫鉤12F 12/19 01:39
推 iWRZ: 前人種樹 後人砍樹 臺灣軟工 莫莫默默17F 12/19 01:43
→ pest: TODO 旁邊加名字 然後寫個git plugin定期提醒 XD18F 12/19 05:22
推 cobrasgo: let codes talk也是要看狀況的，driver的東西不寫註解是要我來查datasheet嗎
還有protocol相關的code也是，不寫註解的話可讀性通常很差
會武斷的說不需要註解的人我不知道你有沒寫過driver
另外linux kernel裡一堆為了優化的組語，不寫註解跟天書一樣19F 12/19 10:19
推 chuegou: 推樓上26F 12/19 10:37
推 guest0710: 試情況還是要加吧 程式活的比git怎麼辦…
啊 我是只寫一般註解部分 名字絕對不放XD27F 12/19 11:51
→ qweqweqweqwe: 那可能是因為小弟沒碰過 driver 的部分，書也是javabase 的關係吧 QQ 看來還是要照不同的情況服用29F 12/19 12:27
→ qrtt1: 就算寫 java 你實在特殊的演算法還是得加註解，
寫寫 reference 或選用公式在裡面啊。31F 12/19 13:01
→ manaup: 有些code無法說明的通靈事件會寫註解喔
像是"xxx user 改了又改 改又改 第7版改回第2版效果"這種"yyy PM特別要求的腦殘功能 預計UAT時會被打槍拿掉"
"20081223 Xmas前趕時程技術積 以後有時間再finetune"
"It's magic. 它會動,還沒有人搞懂為什麼.勿修改"
"這package相關設計和程式是用香蕉買來的"33F 12/19 13:09
推 humanfly: 不確定的我會留名啊，說明原因，sourcesafe+2008要找誰寫的頗麻煩39F 12/19 13:51
推 vn509942: 反正註解區塊可以收起 不影響閱讀41F 12/19 14:02
推 YahooTaiwan: 不是 "不用寫註解"，而是 "不用寫作者名"
只有自己看得懂的演算法或 Protocol 當然要註解
我還以為本文第二行是在問大家要不要寫作者名欸42F 12/19 15:22

--
作者 Byzantin 的最新發文:
點此顯示更多發文記錄