一般来说,程序员看自己一个月前写的代码,是完全陌生的,我也一样,基本上过一个月就没印象了,但是如果要修改/扩展怎么办,这时候,就得看代码注释了。
就个人经验而言,有这么几个地方,一定要写注释:
接口,特别是MVP的Contract接口,这里面基本定义了你的主要业务行为,谁来加载数据,谁来显示数据,谁触发的下一步操作,这些内容写明白了,以后读代码,只要看接口就知道主要业务是怎么回事儿了。
服务、广播等,服务和广播因为没有界面,容易游离在业务逻辑链条之外,在业务逻辑上缺少上下文,就必须有详尽的注释,说明其业务场景。
初始化、注入等,如果自定义了一些扩展的功能或控件,要求执行某些初始化函数,或者要注入特定功能的,就必须写好注释,提示调用者进行必要的操作。
TODO,工作总要排优先级的,有些工作暂时延后,自己记录是没用的,团队开发最终用的还是代码,所以一定要写TODO,提示开发者,这里是未完成的状态,避免不必要的误会和延误。
重庆网站建设、重庆APP开发、重庆小程序开发、重庆网络推广就选天果网络,十余载致力于互联网技术服务、开发及应用,为企事业单位提供一站式、完善的整合网络品牌服务。