DocumentationFile 和 GenerateDocumentationFile 可以在 .Net 项目文件中一起使用吗?
Can DocumentationFile and GenerateDocumentationFile be used together in .Net project file?
我正在为 C# 项目编写一个小型分析器,用于检查 XML 文档生成是否存在并正确设置。指定 XML 文档有两个选项:
- 旧的
DocumentationFile
选项
- 更新的
GenerateDocumentationFile
标志。如果该标志设置为 true,MSBuild 应该在项目的输出目录中生成一个包含项目名称的 XML 文档文件。
能否在项目文件中明确指定这两个选项?
这些选项的值会合并还是其中一个选项将被忽略?
它们都不需要设置。如果 DocumentationFile
不为空,则 GenerateDocumentationFile
将在 MSBuild 目标中设置为 true
。
如果将 GenerateDocumentationFile
设置为 true
,则将根据项目文件名设置 DocumentationFile
的默认值。
相关的 MSBuild 目标
<!-- Handle XML documentation file settings -->
<PropertyGroup Condition="'$(GenerateDocumentationFile)' == ''">
<GenerateDocumentationFile Condition="'$(DocumentationFile)' == ''">false</GenerateDocumentationFile>
<GenerateDocumentationFile Condition="'$(DocumentationFile)' != ''">true</GenerateDocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(GenerateDocumentationFile)' == 'true' and '$(DocumentationFile)' == ''">
<DocumentationFile Condition="'$(MSBuildProjectExtension)' == '.vbproj'">$(AssemblyName).xml</DocumentationFile>
<DocumentationFile Condition="'$(MSBuildProjectExtension)' != '.vbproj'">$(IntermediateOutputPath)$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(GenerateDocumentationFile)' != 'true'">
<DocumentationFile />
</PropertyGroup>
我正在为 C# 项目编写一个小型分析器,用于检查 XML 文档生成是否存在并正确设置。指定 XML 文档有两个选项:
- 旧的
DocumentationFile
选项 - 更新的
GenerateDocumentationFile
标志。如果该标志设置为 true,MSBuild 应该在项目的输出目录中生成一个包含项目名称的 XML 文档文件。
能否在项目文件中明确指定这两个选项? 这些选项的值会合并还是其中一个选项将被忽略?
它们都不需要设置。如果 DocumentationFile
不为空,则 GenerateDocumentationFile
将在 MSBuild 目标中设置为 true
。
如果将 GenerateDocumentationFile
设置为 true
,则将根据项目文件名设置 DocumentationFile
的默认值。
相关的 MSBuild 目标
<!-- Handle XML documentation file settings -->
<PropertyGroup Condition="'$(GenerateDocumentationFile)' == ''">
<GenerateDocumentationFile Condition="'$(DocumentationFile)' == ''">false</GenerateDocumentationFile>
<GenerateDocumentationFile Condition="'$(DocumentationFile)' != ''">true</GenerateDocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(GenerateDocumentationFile)' == 'true' and '$(DocumentationFile)' == ''">
<DocumentationFile Condition="'$(MSBuildProjectExtension)' == '.vbproj'">$(AssemblyName).xml</DocumentationFile>
<DocumentationFile Condition="'$(MSBuildProjectExtension)' != '.vbproj'">$(IntermediateOutputPath)$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(GenerateDocumentationFile)' != 'true'">
<DocumentationFile />
</PropertyGroup>