[請益] 註解的風格

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