visual studio的注釋規範

來源:互聯網
上載者:User

  大多數人都知道Visual Studio使用/*代碼塊*/和//程式碼來注釋代碼,

但是卻沒有規範的對代碼中的函數、類等進行注釋。

  Visual Studio提供了建立代碼報告的功能。其中用到的注釋方法可以很

好的規範我們的注釋,使代碼可讀性更好。

下面是其中的一些注釋標記

先要用///注釋然後加上下面的這些標記

  • <summary></summary>   概括說明。
  • <remarks></remarks>   備忘。
  • <param></param>   在方法聲明的注釋中使用以描述該方法的一個參數。
  • <returns></returns>   在方法聲明的注釋中使用以描述傳回值。
  • <newpara></newpara>   在注釋中開始一個新段落。
  • 例子:

    using System; 
    namespace HelloWorld 

    /// <summary> 
    /// Sample Hello World in C# 
    /// </summary> 
    public class HelloWorld 

    /// <summary> 
    /// Console Application Entry Point 

    /// </summary> 
    /// <param name="args">Command Line Arguments</param> 
    /// <returns>Status code of 0 on successful run</returns> 

    public static int Main(string[] args) 

    System.Console.WriteLine("HelloWorld"); 
    string name = System.Console.ReadLine(); 
    return(0); 


    相關文章

    聯繫我們

    該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

    如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    • Sales Support

      1 on 1 presale consultation

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.