从模板在 C# 中自动生成的代码

Question

我现在正在用 C# 维护别人的代码，但我发现了一些我不确定我是否理解的东西。

到目前为止，当我编写 Winforms 时，我通常会编写我的类（和其他代码）。 然而，在这个程序中有一些模块有部分类，并且在标题中有一个形式的评论

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated from a template.
//
//     Manual changes to this file may cause unexpected behavior in your application.
//     Manual changes to this file will be overwritten if the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

这到底是什么，他们在谈论什么模板？

(*) 这不是某人以图形方式设计表单时生成的自动生成的部分类。 我见过并使用过这些。 我想这是类似但不一样的东西

Answer 1

您的问题下方的评论为您手头的特定案例指明了正确的方向，但考虑一下在使用自动生成的代码（希望通过评论标记为此类）的项目上工作时的一般最佳实践是什么是很有趣的。

好吧，这样的评论告诉您这不是实际的源代码，而是从另一个源转换/生成的代码。 直接修改它确实不是最好的主意，因为生成该代码的过程（很可能作为构建的一部分或使用工具）可以通过覆盖文件来丢弃您的更改。 一种思考方式是，这有点像编译器生成的二进制文件（更正确的术语是中间语言）。 在这种情况下同样适用，修改二进制文件会适得其反，容易出错，并且更改将被实际编译过程丢弃。

此外，这种代码通常遵循严格的约定，如果严格遵守这些约定，则有望工作。 要记住的一件事是，通常这种自动生成的代码是愚蠢的代码，最好留给要生成的工具。

我有时会编写工具来自动生成代码，这对于粘合代码（映射到数据库、序列化等）之类的事情非常有用。 自动生成的测试等。我记得在实际生产代码中使用过的一个特定示例是stubbing 。 我们有一个带有空引用异常的 wpf 客户端。 我的团队花了太多时间逐个修复它们，但一直有更多的问题出现。 在某个时候，我实现了一个可配置的工具，该工具将生成修补数据模型的代码，将默认存根对象替换为空引用。