对于某些方程,我有一些使用doxygen注释的C#代码。 VS2013应该给我一个警告信息
warning CS1570: XML comment on 'myclass' has badly formed XML --
'A name was started with an invalid character.'
我的评论如下,"<"引发了这条警告信息。
/// \f[
/// T_{max}<30
/// \f]
我真的要摆脱这个警告信息。最好的选择是不要更改编译选项以忽略此警告。
我该如何解决?谢谢你的任何建议。
答案 0 :(得分:8)
是的,你需要以<
的XML格式转义<
。
所以这是有效的:
/// \f[
/// T_{max}<30
/// \f]
现在我不知道doxygen如何处理C#中的注释 - 如果它真的想要原始表单,因为它不是以XML格式处理注释,那么你应该在C#项目设置中关闭XML注释。 (基本上你需要提供有效的XML,或者你需要停止任何期望它是有效的XML。)