作者YAYA6655 (YAYA)
看板Soft_Job
标题Re: [讨论] 要不要写注解
时间Sun Oct 27 02:43:38 2019
命名好不用写注解这是不可能的
注解就是白话文,有些超级复杂的东西不管命名多好都不可能看得懂
例如「相对论」这个命名, Relative_Theory ,好棒的命名阿,这样就看懂了?
神。
当然上面的例子是有点夸张,再比方写会计软体,GAAP,IFRS制度变换,摘要肯定很长
,细节就在注解内。
又比方写金融软体,写到什麽动态稳定措施,价格瞬间偏移等,都是专有的观念,这种
也是无论怎麽命名都不可能看懂,因为接手的人要是没有背景知识,就很棘手了。
不写注解,应该是只写资料库的CRUD才会这麽认为吧。这种的确不用写。 :D
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 220.135.144.57 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1572115420.A.123.html
1F:推 itoni: 你说的这种东西应该写在文件而不是注解吧 10/27 03:13
2F:推 senjor: 我是觉得至少要写到你引用外部含式库注解的内容程度啦 10/27 03:26
3F:推 superpai: 这些写在wiki而不是注解好吗 10/27 04:20
4F:推 knives: 有些没sense的主管就会这样 10/27 08:04
5F:推 littlethe: 唉喓,所以注解就要写请参考那一个文件,注解还是要写呀 10/27 09:01
6F:推 BBSealion: 注解跟文件又是一场灾难XD 时常code, 注解, 文件无法 10/27 10:04
7F:→ BBSealion: 良好的保持一致,所以也有提出注解=文件的套件,但也不 10/27 10:04
8F:→ BBSealion: 一定好用,这只能靠工程师自己的美德了XDD 10/27 10:04
9F:→ MonyemLi: 问题不是在於不懂相对论的人怎麽会维护这程式码 10/27 12:34
10F:推 littlethe: 不一致会发生,但有写就有线索可以查,总比什麽都没有好 10/27 13:05
11F:嘘 CoNsTaR: 不知道从哪里开始吐槽... 10/27 19:42
12F:→ YAYA6655: 对阿,哈,至少要摘要一行,注解一行 10/27 22:28
13F:→ Ghamu: 不一致的问题在於误导 可能把问题越弄越糟 10/30 05:02