C# 中的单行和多行注释

2018-08-22 08:00:00 · 飞浪

介绍注释是源代码中的注解，旨在为程序员提供代码的可读性解释。编译器在编译代码时会忽略这些注解。注释应该在比代码更高的抽象层次上解释您要做什么。 C#的注释语法不同。在本指南中，我们将介

介绍

注释是源代码中的注解，旨在为程序员提供代码的可读性解释。编译器在编译代码时会忽略这些注解。注释应该在比代码更高的抽象层次上解释您要做什么。

C# 的注释语法不同。在本指南中，我们将介绍单行注释和多行注释。

单行注释示例

单行注释每次只允许在一行上进行叙述。单行注释可以从给定行的任意列开始，以新行或回车符结束。

//字符序列将其后面的文本标记为单行注释。以下是示例

      class Account
{
  private string _accountNo;

  public Account(string accountNo, int balance)
  {
    AccountNo = accountNo;
    Balance = balance;
  }

  public string AccountNo
  {
    get => _accountNo;
    set
    {
      //raise exception if value is null
      if(String.IsNullOrEmpty(value))
      throw new InvalidOperationException();
      _accountNo = value;
    }
  }

  public int Balance { get; set; }

  public void Credit(int amount)
  {
    Balance = amount + Balance; //update the balance with a summation of the inputted amount and the current balance
    //Logs the new balance to the screen
    Console.WriteLine(Balance);
  }
}
    

上述代码在Credit方法和AccountNo属性的设置访问器中使用单行注释。

多行注释示例

多行注释在一组注释分隔符内包含一行或多行叙述。/*分隔符标记注释的开始，*/标记注释的结束。您可以让注释跨越多行，这些分隔符之间的任何内容都被视为注释。

      class Account
{
  /* Account class constructor.
    In it we initialise the AccountNo and Balance property.
    These properties are needed to identify an account and perform transaction using its available methods
    */
  public Account(int accountNo, int balance)
  {
    AccountNo = accountNo;
    Balance = balance;
  }

  public int AccountNo { get; set; }

  public int Balance { get; set; }

  public void Credit(int amount)
  {
    Balance = amount + Balance;
  }
}
    

它也可以放在代码语句里面。

      var account = new Account(2 /* this is a dummy account number */, 2000);
    

上面的代码告诉读者数字2只是一个假的帐号，稍后应该替换它。使用注释时要小心。如果代码块难以阅读，请尝试将其重写为更易读的形式。

就此结束！

代码注释对于帮助您或其他使用您代码的程序员更好地理解您的代码非常有用。这是一种使用有用的叙述注释源代码的方法。过度使用它会导致源代码难以阅读和理解。

我们研究了 C# 中的单行和多行注释。单行注释在//注释标记后的第一个行尾结束。您可以将其放在代码语句的顶部或代码语句之后。如果它在代码语句之后，则其后的任何文本都被视为注释。另一方面，多行注释可以跨越多行或放在代码语句内，并且只有注释分隔符之间的内容将被视为注释并在编译期间被忽略。

_{免责声明：本内容来源于第三方作者授权、网友推荐或互联网整理，旨在为广大用户提供学习与参考之用。所有文本和图片版权归原创网站或作者本人所有，其观点并不代表本站立场。如有任何版权侵犯或转载不当之情况，请与我们取得联系，我们将尽快进行相关处理与修改。感谢您的理解与支持！}

_查看原文

技术指南

阅读全文

C# 中的单行和多行注释

杭州电子商务研究院

6年前 · 面向社会、服务行业、政产学研结合、整合资源、和谐发展

class Account { private string _accountNo; public Account(string accountNo, int balance) { AccountNo = accountNo; Balance = balance; } public string AccountNo { get => _accountNo; set { //raise exception if value is null if(String.IsNullOrEmpty(value)) throw new InvalidOperationException(); _accountNo = value; } } public int Balance { get; set; } public void Credit(int amount) { Balance = amount + Balance; //update the balance with a summation of the inputted amount and the current balance //Logs the new balance to the screen Console.WriteLine(Balance); } }

class Account { /* Account class constructor. In it we initialise the AccountNo and Balance property. These properties are needed to identify an account and perform transaction using its available methods */ public Account(int accountNo, int balance) { AccountNo = accountNo; Balance = balance; } public int AccountNo { get; set; } public int Balance { get; set; } public void Credit(int amount) { Balance = amount + Balance; } }