我已经为我的 VS 项目打开了“将警告视为错误”,这意味着我会收到缺少文档的错误(对于这个特定项目来说是一个很好的提醒)。
但是,部分代码是由自定义工具生成的,该工具不会插入 xml 文档,因此我希望仅忽略生成的代码(而不是整个项目)缺少的 xml 文档。我对生成的实际文件没有影响,并且无法真正在文件中插入任何内容(因为它经常由工具重新生成),因此我寻找生成文件之外存在的内容(生成的类是部分的,如果有帮助的话)
避免生成的代码出现警告或代码分析错误的最佳方法是用生成的代码属性 http://msdn.microsoft.com/en-gb/library/system.codedom.compiler.generatedcodeattribute.aspx并使代码文件以*.生成的.cs图案。
如果您的代码文件也有文件头,您应该有这些标签:
//----------------------
// <auto-generated>
// Tool description
// </auto-generated>
//----------------------
这不是强制性的,但如果您有代码文件头,那么这是一个很好的做法。
这样,FxCop 和其他工具(如 StyleCop)将不再分析您的代码。
异常的是您的代码生成工具没有使用上述属性来装饰您的代码元素。尝试查看您的工具设置中是否有启用选项或联系开发团队。
编辑:
生成的类是否是部分类,并且实际的类名称和编号是否经常更改?因为如果生成的代码内容移动量不大,您可以做的就是创建另一个代码文件,并声明生成的分部类,并用 GenerationCodeAttribute 来装饰它们。有一次它救了我的命(还有我的时间!)。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)