为缺少的XML文档启用C ++编译器警告

时间:2011-02-28 10:14:06

标签: c++ xml visual-studio-2010 documentation compiler-warnings

为我的C ++项目(托管)启用XML文档时,编译器不会针对缺少注释发出任何警告。

我通过将“生成XML文档文件”(/ doc)设置为true来启用文档生成,如here所述。该项目配置为带有/ clr和警告级别4(/ W4)的动态库。

对于C#项目,编译器在缺少注释时会发出Missing XML comment for publicly visible type or member 'Type_or_Member'警告。为了强制开发人员做出适当的注释,我希望C ++项目具有相同的行为。我如何获得?

1 个答案:

答案 0 :(得分:2)

VC ++ XML注释不像.NET那样处理。 VC ++编译器处理注释并生成.xdc文件,这些文件稍后由名为xdcmake.exe的工具汇编到xml文件中。但是,如果缺少.NET已知的XML注释,则无法告诉编译器发出警告。

(请参阅http://msdn.microsoft.com/en-us/library/ms177227.aspxhttp://msdn.microsoft.com/en-us/library/ms177247.aspx