链接代码的最佳做法是什么?文档并让它们保持最新状态?
实际上,在我的工作中,遗憾的是业务规则没有明确规定,因此我们在编码过程中发现它们。 我知道它不是那么好但是我们的老板提供它们就像鬼......
我正在测试感染&我们正在使用wiki Trac 。我注意到主流框架(弹簧等)严格测试代码和错误机智只是jira上的bug的id。
您可以建议只是简单地评论我的代码。
但是,假设您正在为照顾人类的外星人设计一个应用程序。其中一些人没有一个关于什么是人类的线索。你知道你可能会在未来与一些外星人开发者一起工作。
所以我们有一个HumanFactory创造了一个有骨头,肉体的人...... 我总是喜欢评论课程,但我知道需要大量的评论来充分解释什么是人类。它可能会发展。
我的例子可能听起来很幽默,但我在2年的项目中进行了实验,其中所有业务规则都在某些IT人员内部,而在其他任何地方都没有。他们认为他们像琐碎或自然,因为他们已经习惯了。
所以就像在jira上报告错误的任何测试链接一样,我已经完成了这个过程 *维基上的页面将列出所有具有唯一编号的业务规则(BR):BR1 ... BR101。任何BR都必须尽可能简约。如果不是这种情况,它将被拆分为更多的BR *任何测试都只有简短的描述和评论中规则的链接:参见#BR45
你怎么看?还有其他任何实践吗?
提前致谢
答案 0 :(得分:0)
“链接代码和文档的最佳做法是什么,让它们保持最新状态” - 努力使代码成为文档。
更新:你提到你是“......谈论业务规则而不是技术实现”。许多公司正在使用诸如SpecFlow之类的工具(在.NET世界中)使业务规则“可运行”的路径