注释的编写方式:写明白来龙去脉提高代码产出率

我发现，还是要在每个控制器的头部写好这个控制器的用途。不然接手的技术，看不明白这个控制器是解决哪个业务问题的。然后就会乱加代码。想要对代码进行清理的时候，也不敢随便动。

比如，之前做的passport现在有个Password控制器，之前是某同事做给app客户端，客户端跳转到passport修改密码用的。
后来同事离职了。

我不太清楚

我周六去问问app调用方的技术人员，才知道知道当时的目的：因为app客户端是没有注册的，所以他们后来要加注册页面，passport提供了一个注册页面给他们。他们发现注册做了，干脆连修改密码也做一个算了。

主要是不了解来龙去脉，接手的时候就不敢随便动,如果看到不合理的部分，也不敢去优化，修补。

了解了事物的来龙去脉，当时这样设计的目的或出发点是什么，更加有利于后续的技术人员优化不合理的部分。

沟通成本还是挺高的。影响着开发效率

转载于:https://www.cnblogs.com/wangtao_20/p/4825595.html

注释的编写方式:写明白来龙去脉提高代码产出率相关推荐

poi导出word：包括**普通的段落以及表格**。常用的**api**已经以注释的方式写了进去。
poi导出word:包括普通的段落以及表格.常用的api已经以注释的方式写了进去. 代码如下: /* * @(#)WordExport.java * Copyright (c) * All right ...
pythonic 代码_怎样才能写出Pythonic 的代码？
近来,身边的一些Python 大牛们老是提到一个很时髦的词:Pythonic,但却很少人说得清楚它是个什么意思,搞得新童鞋一头雾水: 在我们周围有很多资深的工程师,用其他语言写过很多的代码,做过很多项 ...
提高代码质量：如何编写函数
原文地址:http://luopq.com/2016/02/21/write-good-function/ 函数是实现程序功能的最基本单位,每一个程序都是由一个个最基本的函数构成的.写好一个函数是提 ...
FPGA Vivado XDC 约束文件编写方式语法笔记
参考手册: UG625:https://china.xilinx.com/support/documentation/sw_manuals/xilinx14_7/cgd.pdf UG903:https ...
javascript 编码规范用更合理的方式写 javascript
目录类型引用对象数组解构 Strings 函数箭头函数构造器模块 Iterators and Generators 属性变量 Hoisting 比较运算符和等号代码块注释空白 ...
在阿里写了8年代码后，我才明白这些道理
导读: 很多工程师在工作一段时间后会遇到迷茫期,虽有技术傍身,也难免会产生焦虑,反复思考怎样才能快速成长.关于如何提高自己的思考力,运用思考的力量推动能力提升,以此实现技术成长,阿里巴巴盒马产品技术部 ...
WEB UI篇——以结构化的方式写CSS
我的职业是码农,以前有人称这职业叫程序员或软件工程师,不过这些不重要,重要的是我这次写的东西和码农几乎不相干,我接触CSS的时间不长,2年多一点,并且只有在极端的情况下我才会自己动手写CSS,例如:需 ...
用html设计蝙蝠侠介绍,编写你的第一行 HTML 代码，来帮助蝙蝠侠写一封情书
原标题:编写你的第一行 HTML 代码,来帮助蝙蝠侠写一封情书编译自: https://medium.freecodecamp.org/for-your-first-html-code-lets-h ...
JavaScript--------------------jQuery中.bind() .live() .delegate() .on()的区别和三种方式写光棒事件动画...
bind(type,[data],fn) 为每个匹配元素的特定事件绑定事件处理函数. $("a").bind("click",function(){alert( ...

注释的编写方式:写明白来龙去脉提高代码产出率

注释的编写方式:写明白来龙去脉提高代码产出率相关推荐

最新文章

热门文章