#if DEBUG 与条件条件(“DEBUG”)

Question

在大型项目中哪个更好用，以及为什么：

#if DEBUG
    public void SetPrivateValue(int value)
    { ... }
#endif

或

[System.Diagnostics.Conditional("DEBUG")]
public void SetPrivateValue(int value)
{ ... }

Answer 1

这实际上取决于您的目的：

• #if DEBUG：此处的代码在发布时甚至不会达到 IL。
• [Conditional("DEBUG")]：此代码将到达 IL，但是除非在编译调用方时设置了 DEBUG，否则对该方法的调用将被省略。

就我个人而言，我根据情况使用两者：

Conditional("DEBUG") 示例： 我使用这个，这样我就不必在发布期间返回并编辑我的代码，但在调试期间我想要确保我没有犯任何错别字。当尝试在 INotifyPropertyChanged 内容中使用属性名称时，此函数会检查我是否正确键入属性名称。

[Conditional("DEBUG")]
[DebuggerStepThrough]
protected void VerifyPropertyName(String propertyName)
{
    if (TypeDescriptor.GetProperties(this)[propertyName] == null)
        Debug.Fail(String.Format("Invalid property name. Type: {0}, Name: {1}",
            GetType(), propertyName));
}

您确实不想使用 #if DEBUG 创建函数，除非您愿意使用相同的 #if DEBUG 包装对该函数的每个调用：

#if DEBUG
    public void DoSomething() { }
#endif

    public void Foo()
    {
#if DEBUG
        DoSomething(); //This works, but looks FUGLY
#endif
    }

与：

[Conditional("DEBUG")]
public void DoSomething() { }

public void Foo()
{
    DoSomething(); //Code compiles and is cleaner, DoSomething always
                   //exists, however this is only called during DEBUG.
}

---

#if DEBUG 示例： 我在尝试为 WCF 通信设置不同的绑定时使用它。

#if DEBUG
        public const String ENDPOINT = "Localhost";
#else
        public const String ENDPOINT = "BasicHttpBinding";
#endif

在第一个示例中，代码全部存在，但除非打开 DEBUG，否则将被忽略。在第二个示例中，const ENDPOINT 设置为“Localhost”或“BasicHttpBinding”，具体取决于是否设置了 DEBUG。

---

更新：我正在更新这个答案，以澄清一个重要而棘手的点。如果您选择使用 ConditionalAttribute，请记住，调用会在编译期间被省略，而不会在运行时。即：

MyLibrary.dll

[Conditional("DEBUG")]
public void A()
{
    Console.WriteLine("A");
    B();
}

[Conditional("DEBUG")]
public void B()
{
    Console.WriteLine("B");
}

当该库针对发布模式（即没有 DEBUG 符号）进行编译时，它将永远从 A() 内调用 B()省略，即使包含对 A() 的调用，因为 DEBUG 是在调用程序集中定义的。

Answer 2

嗯，值得注意的是，它们根本不是同一件事。

如果未定义 DEBUG 符号，则在第一种情况下，SetPrivateValue 本身不会被调用...而在第二种情况下，它将存在，但任何调用者 在没有 DEBUG 符号的情况下进行编译的人将省略这些调用。

如果代码及其所有调用者位于同一个程序集中，则这种差异不太重要 - 但这意味着在第一种情况下，您还需要有#if也围绕调用代码进行调试。

就我个人而言，我推荐第二种方法 - 但您确实需要在头脑中清楚地了解它们之间的区别。

Answer 3

我确信很多人会不同意我的观点，但是作为一名构建人员，我经常听到“但它可以在我的机器上运行！”，我认为你几乎不应该使用任何一个。如果您确实需要进行测试和调试，请找出一种方法使可测试性与实际的生产代码分开。

在单元测试中通过模拟抽象场景，为您想要测试的一次性场景制作一次性版本，但不要将调试测试放入您为生产版本测试和编写的二进制文件的代码中。这些调试测试只是向开发人员隐藏了可能的错误，因此直到流程后期才发现它们。

Answer 4

这个也很有用：

if (Debugger.IsAttached)
{
...
}

Answer 5

对于第一个示例，如果未定义 DEBUG，则 SetPrivateValue 将不会存在于构建中，对于第二个示例，调用 如果未定义 DEBUG，SetPrivateValue 将不会存在于构建中。

对于第一个示例，您还必须使用 #if DEBUG 包装对 SetPrivateValue 的所有调用。

在第二个示例中，对 SetPrivateValue 的调用将被省略，但请注意 SetPrivateValue 本身仍将被编译。如果您正在构建库，那么引用您的库的应用程序仍然可以使用您的函数（如果满足条件），这非常有用。

如果您想省略调用并节省被调用者的空间，您可以结合使用这两种技术：

[System.Diagnostics.Conditional("DEBUG")]
public void SetPrivateValue(int value){
    #if DEBUG
    // method body here
    #endif
}

Answer 6

我们假设您的代码还有一个 #else 语句，它定义了一个空存根函数，解决了 Jon Skeet 的观点之一。两者之间还有第二个重要区别。

假设 #if DEBUG 或 Conditional 函数存在于主项目可执行文件引用的 DLL 中。使用#if，将根据库的编译设置执行条件评估。使用 Conditional 属性，将根据调用者的编译设置执行条件评估。

Answer 7

我有一个 SOAP WebService 扩展，可以使用自定义 [TraceExtension] 记录网络流量。我仅将其用于调试构建，并在发布构建中省略。使用#if DEBUG 包装[TraceExtension] 属性，从而将其从Release 版本中删除。

#if DEBUG
[TraceExtension]
#endif
[System.Web.Service.Protocols.SoapDocumentMethodAttribute( ... )]
[ more attributes ...]
public DatabaseResponse[] GetDatabaseResponse( ...) 
{
    object[] results = this.Invoke("GetDatabaseResponse",new object[] {
          ... parmeters}};
}

#if DEBUG
[TraceExtension]
#endif
public System.IAsyncResult BeginGetDatabaseResponse(...)

#if DEBUG
[TraceExtension]
#endif
public DatabaseResponse[] EndGetDatabaseResponse(...)

Answer 8

通常，您会在 Program.cs 中需要它，您希望决定在非调试代码上运行调试，并且大多数情况下在 Windows 服务中运行调试。因此，我创建了一个只读字段 IsDebugMode 并在静态构造函数中设置其值，如下所示。

static class Program
{

    #region Private variable
    static readonly bool IsDebugMode = false;
    #endregion Private variable

    #region Constrcutors
    static Program()
    {
 #if DEBUG
        IsDebugMode = true;
 #endif
    }
    #endregion

    #region Main

    /// <summary>
    /// The main entry point for the application.
    /// </summary>
    static void Main(string[] args)
    {

        if (IsDebugMode)
        {
            MyService myService = new MyService(args);
            myService.OnDebug();             
        }
        else
        {
            ServiceBase[] services = new ServiceBase[] { new MyService (args) };
            services.Run(args);
        }
    }

    #endregion Main        
}