Re: [讨论] 要不要写注解

楼主: YAYA6655 (YAYA)   2019-10-27 02:43:38
命名好不用写注解这是不可能的
注解就是白话文,有些超级复杂的东西不管命名多好都不可能看得懂
例如“相对论”这个命名, Relative_Theory ,好棒的命名阿,这样就看懂了?
神。
当然上面的例子是有点夸张,再比方写会计软件,GAAP,IFRS制度变换,摘要肯定很长
,细节就在注解内。
又比方写金融软件,写到什么动态稳定措施,价格瞬间偏移等,都是专有的观念,这种
也是无论怎么命名都不可能看懂,因为接手的人要是没有背景知识,就很棘手了。
不写注解,应该是只写数据库的CRUD才会这么认为吧。这种的确不用写。 :D
作者: itoni (每天都过得很混)   2019-10-27 03:13:00
你说的这种东西应该写在文件而不是注解吧
作者: senjor (哞哞)   2019-10-27 03:26:00
我是觉得至少要写到你引用外部含式库注解的内容程度啦
作者: superpai (超级白)   2019-10-27 04:20:00
这些写在wiki而不是注解好吗
作者: knives   2019-10-27 08:04:00
有些没sense的主管就会这样
作者: littlethe (东周流浪汉)   2019-10-27 09:01:00
唉喓,所以注解就要写请参考那一个文件,注解还是要写呀
作者: BBSealion (海狮)   2019-10-27 10:04:00
注解跟文件又是一场灾难XD 时常code, 注解, 文件无法良好的保持一致,所以也有提出注解=文件的套件,但也不一定好用,这只能靠工程师自己的美德了XDD
作者: MonyemLi (life)   2019-10-27 12:34:00
问题不是在于不懂相对论的人怎么会维护这程式码
作者: littlethe (东周流浪汉)   2019-10-27 13:05:00
不一致会发生,但有写就有线索可以查,总比什么都没有好
作者: CoNsTaR ((const *))   2019-10-27 19:42:00
不知道从哪里开始吐槽...
楼主: YAYA6655 (YAYA)   2019-10-27 22:28:00
对阿,哈,至少要摘要一行,注解一行
作者: Ghamu (猫丸)   2019-10-30 05:02:00
不一致的问题在于误导 可能把问题越弄越糟

Links booklink

Contact Us: admin [ a t ] ucptt.com