通常,在任何开发中,有必要编写预先知道它的代码:
- 极其不灵活。或者..
- 将来可能会导致错误和问题。或者..
- 我们根本不读书。
或者这样的代码是继承而来的,你想把以后需要理顺的地方标出来。这样的代码在俄语中称为拐杖。不幸的是,很难在英语网站上找到有关此的信息,因为它们原则上没有术语“拐杖”。建议翻译为“kludge”——但这并不经常被理解。
问题是如何用注释标记代码中的拐杖,这样就可以很容易地列出项目中的所有拐杖,并且非常希望它们在 IDE 中可见,甚至可以确定优先级?我对 PhpStorm 更感兴趣,但其他人可能有兴趣了解他们的 IDE。
PS
评论里当然有专门的标注TODO,但是我想把拐杖TODO分开来介绍一下,毕竟本质上还是有很大区别的。因此,一些人同意特殊评论,例如:
/* TRASHCODE {why below code is bad} */
...
/* TRASHCODE end*/
然后就很容易搜索到代码了,但是在这种情况下,IDE 在审查拐杖方面没有任何帮助。
首先,所有体面的 IDE
TODO也理解“开箱即用”FIXME。其次,所有体面的 IDE :) 都可以添加自定义任务标签。
PhpStorm(以及任何其他 jetbrain 的):
Eclipse(甚至可以为每种语言/项目定制):
据我了解-不,到处都只跟踪带有关键字的一行。最大的可能就是在对应的tab里面点一下,然后到源码里的这个地方。
克里昂:
已收藏:
日蚀:
已收藏:
如果你不能为特定任务编写简洁灵活的代码,那么你的架构设计就有问题,你应该提高你的技能,新手开发人员由于缺乏经验而出现这样的问题。请记住,一个拐杖需要一堆新拐杖,扩展系统及其功能以及进行更改都将很困难。
你对英语缺少拐杖有点不对,它通常被称为kludge或workaround
需要修复的代码片段通常用FIXME标记,许多编辑器和 PHPSTORM 都支持它,它在 TODO 中标记。FIXME 紧接在有问题的成员之前,可能包含对哪些代码行存在问题以及需要修复哪些问题的描述,没有分隔符。
体验
我可以说我和我的同事们很少标记拐杖。通常他们在新任务或错误搜索时立即重写而没有标记(班级已经解雇了几次,即使在更正之后),因为所有这些标记都在缺乏时间的情况下变成了永久标记。自然地,拐杖正在被不狂热地重写,以节省业务资金用于产品的进一步开发和支持。
如果团队保持高度抽象的愿望,遵守类中行数的规则,重构一些歪歪扭扭的代码花不了多少时间,但如果是继承的,那么就需要确定层次根据为任务提供的时间进行重构。
PS 避免不必要的范例:costing、incostyling和polycosting,编写漂亮的代码,至少附上一分钟的设计。
PHP
javascript