首页 > 编程语言 >c#基础

c#基础

时间:2024-10-29 17:14:01浏览次数:2  
标签:XML c# 基础 注释 C# 用于 方法 属性

一、C# 中 // 注释和 /// 注释的区别

/// 会被编译, // 不会

所以使用 /// 会减慢编译的速度(但不会影响执行速度)

/// 会在其它的人调用你的代码时提供智能感知

/// 也是一种注释,但是这种注释主要有两种作用:

  •  1.这些注释能够生成一个XML文件。这样呢,看起来会对程序的内容一目了然。
  •  2.以这种方式对你的类,属性,方法等等加上注释之后,当你在其他地方使用以这种方式加上的类,属性,方法等等地时候,黄色的提示框里面会把你写的注释显示出来,是你更加明白你要使用的功能的作用。
/// <summary>
///定义用户姓名属性,该属性为可读可写属性
/// </summary>

C# 编码的时候,常常涉及代码注释,常见的注释包括两类:

  •  1)单行注释。格式:// Comments
  •  2)多行注释。格式:/* Comments... */

C# 引入了新的 XML 注释,即我们在某个函数前新起一行,输入 ///,VS.Net 会自动增加XML格式的注释,这里整理一下可用的XML注释。 XML 注释分为一级注释(Primary Tags)和二级注释(Secondary Tags),前者可以单独存在,后者必须包含在一级注释内部。

I 一级注释

1. <remarks>对类型进行描述,功能类似<summary>,据说建议使用<remarks>;
2. <summary>对共有类型的类、方法、属性或字段进行注释;
3. <value>主要用于属性的注释,表示属性的制的含义,可以配合<summary>使用;
4. <param>用于对方法的参数进行说明,格式:<param name="param_name">value</param>;
5. <returns>用于定义方法的返回值,对于一个方法,输入///后,会自动添加<summary>、<param>列表和<returns>;
6. <exception>定义可能抛出的异常,格式:<exception cref="IDNotFoundException">;
7. <example>用于给出如何使用某个方法、属性或者字段的使用方法;
8. <permission>涉及方法的访问许可;
9. <seealso>用于参考某个其它的东东:),也可以通过cref设置属性;
10. <include>用于指示外部的XML注释;

II 二级注释

1. <c> or <code>主要用于加入代码段;
2. <para>的作用类似HTML中的<p>标记符,就是分段;
3. <pararef>用于引用某个参数;
4. <see>的作用类似<seealso>,可以指示其它的方法;
5. <list>用于生成一个列表;
另外,还可以自定义XML标签 

二、让C#智能注释时显示为换行

在C#智能注释时,常常希望它能在开发时显示为换行,使得提示更加友好!原来一直想怎么实现,今天偶然发现原来如此简单,只需将<para> 标记用于诸如 <summary>、<remarks> 或 <returns> 等标记内即可。

注释在开发时换行显示的办法

<para> 标记用于诸如 <summary>、<remarks> 或 <returns> 等标记内,使您得以将结构添加到文本中。 

/// <summary> 
/// 基类(第1行) 
///<para>说明:(第2行)</para> 
///<para>  封装一些常用的成员(第3行)</para> 
///<para>  前面要用全角空格才能显示出空格来(第4行)</para> 
/// </summary> 
public class MyBase 
{ 
      /// <summary> 
      /// 构造函数(第1行) 
      ///<para>说明:(第2行)</para> 
      ///<para>  初始化一些数据(第3行)</para> 
      /// </summary> 
      public MyBase() 
      { 
            // 
            //TODO: 在此处添加构造函数逻辑 
            // 
       } 
} 

标签:XML,c#,基础,注释,C#,用于,方法,属性
From: https://www.cnblogs.com/Christmas77/p/18513938

相关文章

  • 如果想用ECS实现技能系统有什么好的思路
    1)如果想用ECS实现技能系统有什么好的思路2)在使用RecastNavigation时遇到的两个问题3)通过摇杆控制角色移动时,怎么获取要移动方向上的坐标4)有判断一个点是否在NavMesh上的接口吗这是第406篇UWA技术知识分享的推送,精选了UWA社区的热门话题,涵盖了UWA问答、社区帖子等技术知识点,助力......
  • C#基础数据类型
    C# 数据类型在C#中,变量分为以下几种类型:值类型(Valuetypes)引用类型(Referencetypes)指针类型(Pointertypes)值类型(Valuetypes)值类型变量可以直接分配给一个值。它们是从类 System.ValueType 中派生的。值类型直接包含数据。比如 int、char、float,它们分别存储数字......
  • C# 类型转换
    C# 类型转换在C#中,类型转换是将一个数据类型的值转换为另一个数据类型的过程。C#中的类型转换可以分为两种:隐式类型转换和显式类型转换(也称为强制类型转换)。隐式类型转换隐式转换是不需要编写代码来指定的转换,编译器会自动进行。隐式转换是指将一个较小范围的数据类型转......
  • 2024年最佳CRM深度解析:企业用户首选
    目前,随着信息的飞速发展,中国CRM市场迎来了前所未有的发展机遇,各类CRM系统如雨后春笋般涌现,为企业提供了丰富的选择。在众多CRM系统中,哪些能够脱颖而出,成为企业用户的首选呢?以下是2024年最佳CRM系统排行榜,其中纷享销客凭借其卓越的表现荣登榜首。1.纷享销客:市场领导者市场地位:......
  • C# 变量
    C# 变量一个变量只不过是一个供程序操作的存储区的名字。在C#中,变量是用于存储和表示数据的标识符,在声明变量时,您需要指定变量的类型,并且可以选择性地为其分配一个初始值。在C#中,每个变量都有一个特定的类型,类型决定了变量的内存大小和布局,范围内的值可以存储在内存中,可......
  • 重要webpack性能优化
    1.webpack优化打包构建速度-开发体验和效率优化babel-loader缓存:cacheDirectory,只要加了这个,es6代码中没有改动的就不会重新编译,集中缓存,加快速度。IgnorePlugin避免引入无用模块比如有个Moment.js库支持很多语言避免引入过多的语言,动态引入。noParse避免重复......
  • C# 变量作用域
    C#变量作用域在C#中,变量的作用域定义了变量的可见性和生命周期。变量的作用域通常由花括号 {} 定义的代码块来确定。以下是关于C#变量作用域的一些基本规则:局部变量在方法、循环、条件语句等代码块内声明的变量是局部变量,它们只在声明它们的代码块中可见。实例void ......
  • chromedriver安装
    chromedriver安装1、谷歌浏览器的版本必须与chromedriver版本一致查看谷歌浏览器版本,打开谷歌浏览器->设置->帮助->找到版本号,例如129.0.6668.1012、参考官网最新版的下载地址https://googlechromelabs.github.io/chrome-for-testing,拼接出自己需要的例如,打开下面网址,即可直......
  • RBE104TC C/C++ Programming Language
    RBE104TCC/C++ProgrammingLanguageAssignment2ContributiontotheOverallMarks70%IssueDateSubmissionDeadline3rdNovember2024AssignmentOverview:ThisassignmentisgearedtowardsassessingfundamentalcodingconceptsinC/C++andinitiatingthe......
  • STM32+致远电子Dport模块的Ethercat从站开发
    环境准备硬件环境1.Dport-stm32评估板2.stlink3.千兆网线4.安装有twincat3的上位机电脑(带千兆网口) 软件环境1.TC31-FULL-Setup.3.1.4024.53.exe2.mdk5开发环境3.SSCTool.exe4.stm32cubemx 例程资料1.致远电子官网 开发流程1.底层硬件EPC103-DP系统框图,......