作者Byzantin (拜占庭)
看板Soft_Job
标题[请益] 注解的风格
时间Fri Dec 18 19:20:57 2015
请问一下各位
有在注解里写上自己的名字的习惯吗?
我们有在使用git, 哪段code是谁写的很容易知道
我自己觉得不太需要注解说是谁写的。
请问大家对这样做法的看法是
谢谢
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 123.51.170.59
※ 文章网址: https://webptt.com/cn.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