Warning 任务

基于评估的条件语句,在生成期间记录警告。

参数

下表描述了 Warning 任务的参数。

参数 说明
Code 可选 String 参数。

与警告相关联的警告代码。
File 可选 String 参数。

指定相关文件(如果有)。 如果未提供任何文件,则使用包含 Warning 任务的文件。
HelpKeyword 可选 String 参数。

与警告关联的 Help 关键字。 仅供内部使用。
HelpLink 可选 String 参数。

警告详细信息的链接。
Text 可选 String 参数。

如果 Condition 参数计算结果为 true,则为 MSBuild 记录的警告文本。

注解

Warning 任务使 MSBuild 项目可以在继续下一个生成步骤之前,先检查必需的配置或属性是否存在。

Warning 任务的 Condition 参数的计算结果为 true 时,将记录 Text 参数的值,并继续执行生成操作。 如果 Condition 参数不存在,则记录警告文本。 有关日志记录的详细信息,请参阅获取生成日志

除上面列出的参数外,此任务还从 TaskExtension 类继承参数,后者自身继承自 Task 类。 有关这些其他参数的列表及其说明的信息,请参阅 TaskExtension 基类

Visual Studio 使用 HelpKeyword 来支持上下文帮助功能 (F1)。 可使用 HelpLink 将联机帮助页与错误消息相关联。

示例

以下代码示例检查在命令行上设置的属性。 如果未设置任何属性,则项目将引发警告事件,并记录 Warning 任务的 Text 参数的值。

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <Target Name="ValidateCommandLine">
        <Warning
            Text=" The 0 property was not set on the command line."
            Condition="'$(0)' == ''" />
        <Warning
            Text=" The FREEBUILD property was not set on the command line."
            Condition="'$(FREEBUILD)' == ''" />
    </Target>
    ...
</Project>

另请参阅