visual studio的注释规范

  大多数人都知道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); 


  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值