提示8-8:使用源代码记录概念!

提示8-8:使用源代码记录概念!

#concept #source-code #example #test

“用戒律教学是一条漫长的道路,但以身作则是短暂而有益的道路。”(引用小塞内卡)

开发人员通常会是arc42概念的使用者,开发人员对完成工作非常感兴趣。他们需要知道他们如何能够或应该实现他们的目标?

回答这些问题的最具体方法是……源代码:

显示选定的单元测试

单元测试有其先决条件(在设置方法中)和其断言/后果(在断言语句中)是明确的。

自动包含代码工件

在理想情况下,您直接从代码存储库、版本控制系统(如Git或Subversion)中包含源代码。这可以确保您的arc42文档始终包含当前、经过测试和正确的代码。

如果您的工具不允许自动包含,请参考相关代码,而不是复制/粘贴它。小心-您的引用越具体(即方法名称),就越有可能改变。

不要复制/粘贴!

如果一切都失败了-您绝对必须复制/粘贴代码,那么请限制在最基本或最重要的部分。不要手动将大量代码片段复制到您的文档中。