如何捕获个人或组织编程最佳实践?

时间:2018-05-20 17:16:32

标签: checkstyle code-documentation

......或者,捕获最佳做法的最佳做法是什么?

请注意,我不是在问这些 这些最佳做法是什么。这些因人而异,团队与团队,语言与语言,域与域之间会有所不同。

为了澄清,我很好奇是否有任何接近标准来捕获编码最佳实践,例如......

示例最佳做法

  • 命名惯例
  • 使用的评论标签
  • 大括号定位圣战
  • 记录政策
  • 限制或强调各种设计模式
  • 何时打破单独的功能,文件或库

......等等。显然这个列表可以永远持续下去!

捕捉是什么意思?

我的意思是以最有用的方式编码这些最佳实践。

将这些信息保持为所谓的部落知识是一种微弱的捕获形式,因为它容易出现不一致和数据丢失,并且不易执行。

维护checkstyle配置是一种强大的捕获形式,因为它非常明确且易于实施。但是,它不够灵活,无法捕捉到更高层次的思维。

我知道的解决方案

  • 合并清洁代码或代码完成等经典,不可自定义或特定于域名,
  • 利用像checkstyle这样的工具,它无法捕捉模糊或
  • 创建自定义文档。

还有更好的东西吗?谢谢!

0 个答案:

没有答案