作者penut85420 (大欧派萝莉)
看板Soft_Job
标题Re: [请益] 写注解到底是不是好习惯
时间Sun Dec 30 04:12:51 2018
※ 引述《sec5566 (sec)》之铭言:
: 以前上课跟书本都提到写注解,
: 但是我看资深同事还有接手的程式码,
: 都没有注解,只有我在写,
: 还被主管念过写注解没必要,
: 命名好就够了,
: 是我观念落伍了吗?
: -----
: Sent from JPTT on my Sony H4331.
这系列的文章讨论下来的节奏很奇怪
要不要写注解听起来只是单个议题
但应该是有很多个面向的
例如注解的长短、阅读的对象
不同的角度讨论的内容就不一样
像是同个team高手写的code要给高手看
我想不加注解应该OK反正都是高手
如果是高手写给新手看
我想加点注解是好的
新来的总是需要多点关照((?
但新手写的code不加注解
我想读起来是费力了点
还有像是常见Framework都有注解
毕竟有众多面向的user
我想阅读注解的门槛还是比较低一点
要一口气就能写出程式即注解的
还蛮需要一点功力的
然而要能够写出好注解
也是很需要功力的
不论是好的程式逻辑或是好的注解
目的都是为了让别人或自己读code更轻松
我觉得作为一个资讯人
这两种做法都应该试着去练习
毕竟不同环境有不同的做法
若是会的更多,机会自然更多
-----
Sent from JPTT on my Asus ASUS_Z01HDA.
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 223.137.208.45
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1546114375.A.F02.html
1F:→ pttworld: 有些人是先写逐行注解,再把程式码填上去 12/30 08:21