coding-style - 软件最佳实践所需的培训主题

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

---

想要改进这个问题吗？更新问题，以便 editing this post 可以用事实和引文来回答它。 .

已关闭10 年前。

Improve this question

很抱歉在这里发布这个平凡的问题，但我需要帮助!

我必须为一些人进行 1 小时的软件最佳实践培训我公司的程序员。观众是几年前的新生有经验的小伙伴们。

你们能给我推荐一些我可以涵盖的相关主题吗？

我可以想到以下内容:

1) 遵循编码标准、缩进的重要性2) 文件、变量、函数、类、表的正确命名列、 View 和所有其他工件3) 对应用程序进行分层 - 每层必须解决特定的问题忧虑4)将常见的东西抽象为可重用的实用程序类

任何帮助将不胜感激(对这篇文章的积极回应，我保证我会为通过回复至少 10 个帖子来社区!)

Answer 1

你提到的话题都很好。如果您只想简要提及每个内容，并因此想添加其他内容，您可以考虑其中的一些(排名不分先后):

• 自动化，自动化，自动化:无聊、重复的任务比让它们需要用户关注更适合自动脚本。例如，大多数编码标准(所有可以“机械”检查的标准)必须在向存储库提交代码时由脚本自动检查(“lint-like”是它们的经典名称)(如果您没有好的源代码版本控制系统会放弃其他所有内容并将所有内容集中于此，当然，因为它是最重要的工具)。
• 测试:自动化且可自动重复的单元测试和集成测试，以及始终运行它们的持续构建工具，是防止代码库意外损坏的绝佳保障。

• 强制性的、轻量级的代码审查(或结对编程):未经其他人的眼睛检查并批准它，任何代码都不应进入代码库 - 不是重复“类似 lint 的”部分，而是为了检查那些太难自动检查的内容——标识符是否清晰且适当，可重用内容的重构是否正确，&c

  • 正确使用注释:他们不应该向任何掌握该语言的人重复代码已经明确说明的内容——他们应该添加有用、简洁的信息，否则这些信息不会立即方便。 C 语言中的一个坏例子，一个好例子，一个最好的例子......:

  /* 糟糕——事实上，非常糟糕/我+= k；/ 将 i 增加 k */

  /* 不错，或者至少不错；-) /我+= k；/ 小部件数量随 thingamajig 数量增长 */

  /* 最好 */widget_count += thingamajig_count;

(在最后一种情况下不存在注释也不需要 - 代码和标识符远非总是可能相当如此清晰以至于完全不需要注释，但是，在可行的情况下，这绝对是最好的!-)。