【Visual Studio】Visual C# 中XML注释的使用(含注释在开发时显示换行)

为函数方法注释说明要用到 xml 语句 <summary> 段落说明 </summary> 、<para> 新段示例说明 </para>、<para>  </para> 空行要加入全角空格

下面的注释会破坏原有标注结构:

[csharp] view plain copy

  1. /// <summary> 第一行 说明
  2. /// <para>第二行说明</para>
  3. /// <para> ←最前面的空格要加入全角空格才会显示</para><para> </para><para> 上面一行是空行</para>
  4. /// <param name="s"> s 为表名,不要加 .xml 后缀</param>
  5. /// <para> 异常:...</para>
  6. /// <returns> 返回:成功 - true;失败 - false。</returns>
  7. ///</summary>
  8. private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){}

原语句:

[csharp] view plain copy

  1. /// <summary> 第一行 说明
  2. /// <para>第二行说明</para>
  3. /// <para> ←最前面的空格要加入全角空格才会显示</para><para> </para><para> 上面一行是空行</para>
  4. /// <para> </para>
  5. /// <para> 异常:《说明...》</para>
  6. ///</summary>
  7. /// <param name="s"> s 为表名,不要加 .xml 后缀</param> /// <returns> 返回:成功 - true;失败 - false。</returns>
  8. private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){}

原文链接:Visual C#XML注释的使用

时间: 2024-10-10 00:17:09

【Visual Studio】Visual C# 中XML注释的使用(含注释在开发时显示换行)的相关文章

Visual Studio 2010 Ultimate 中对于VC++6 0的经典回归

Visual Studio 2010 Ultimate 中对于VC++6.0的经典回归 1. 工具箱中加入了大量BCG控件:2. 选项中原来全局的VC目录设置,现在作为一个属性页放在了工程属性框中,也就是说可以对每个工程设置不同的VC目录:3. 恢复了VC6.0中经典的类向导:4. 这个版本为英文版,但是可以根据创建工程中的语言选项,生成相应语言的代码注释:5. 在对话框设计界面中可以选择设置Mockup Image: Visual Studio 2010 的界面 项目生成向导 新工程向导 代码

在Visual Studio 14 CTP中启用C# 6.0的新特性

今天看到Visual Studio 14 CTP版本已经发布了,支持了一些c++ 及C# 6.0的新特性,便下载下了尝鲜试了一下. C++到还好,使用C#的新特性就有点麻烦了,需要在csproj文件中加上这样一行才能使用     <LangVersion>experimental</LangVersion> 最开始我想写个VS插件来弄下.试了下找不到啥相关的API,便改写了一个小程序来转换它,使用了后还是觉得但文件太多时候很麻烦. 就干脆写了一个小程序把所有的模板中都添加了这一项,

在Visual Studio for Mac中使用fastlane管理iOS的provision

Xamarin开发中,最烦的就是provision的管理了. 全手工的话,要先创建一个key,上传后生成cert文件,再创建provision.如果在手机上调试,还要把手机加到provision中去.非常的烦,而且要命的是,经常出错,要么是不能下载到手机上调试,要么不能生成发布包.有时候一两个小时过去了编译调试都还没成功. 直到我发现Xamarin Studio中的fastlane,一切都改变了.应该说直到发现Visual Studio for Mac中完美集成了fastlanme,Xamari

Visual Studio 2008项目中WinForm窗体图标显示为类图标,只能打开代码而无法打开视图问题解决

背景: 今天打开一个Winform项目的时候,图标显示为类文件的样子而不是窗体的样子,在代码中右键也没有View Designer选项,双击图标打开的是代码而非窗体设计界面,百度后也没有找到解决方案. 解决方法(不一定通用): 1.编译项目查看有没有错误. 2.查看WinForm窗体继承的窗体文件可以打开不?有没有问题 3.签出代码,在undocheckout,编译,查看是否可以了 4.查看该项目有没有被其他人签出,如果被签出,让他们签入,再获取一下最新版本代码,编译,看看是不是可以了(我在这一

在Visual Studio和MyEclipse中建立UML图

最近在看<Head First设计模式>,在前面的博客中我也提到了这本书,这是一本非常经典,非常通俗易懂的书,写得很好.因为这本书是使用java描述的,所以我就使用了MyEclipse写了点代码,之前一直使用VS,VS中建立UML图的功能还是非常强大的,现在发现MyEclipse中也可以建立UML图,而且功能也很强大,学习设计模式的时候,结合类图学习,会事半功倍的.下面就来说说在Visual Studio和MyEclipse中建立UML图的过程,这里以类图为例,其他图的建立过程与类图差不多.博

如何通过PowerShell在Visual Studio的Post-build中预热SharePoint站点

问题现象 Visual Studio在开发SharePoint的时候,发布部署包后,首次打开及调试站点页面的时候会非常的慢 ? 解决方案 使用PowerShell脚本,加载SharePoint插件后遍历所有的网站集,用以模拟用户自动点击页面 ? 具体步骤 制作"64位版本"的PowerShell 由于SharePoint运行的是64位的PowerShell,而Visual Studio的Post-build event中默认运行的32位的PowerShell,需要找到一个变通的方式 ?

visual studio 项目工程中相对目录

最近从TFS拿到一个很久没有人维护的项目,老是提示dll找不到. 弱弱地研究了一下,原来是相对路径惹的祸. 1. C#中相对路径的表示:. 表示当前目录,..表示上一级目录 2. 工程中的引用 <Reference Include="XXXX.Data"> <HintPath>..\..\..\..\..\..\..\Common\XX\XX\XX\v1.1.0.1105\XXXX.Data.dll</HintPath> </Reference

Visual Studio 2019 preview中体验C# 8.0新语法

准备工作: Visual Studio 2019 Preview版本中并没有包含所有的C# 8.0的新功能,但目前也有一些可以试用了.在开始之前,需要进行入两项设置: 将Framework设置为.net core 3.0 将C#语法设置为8.0 也可以直接编辑.csproj文件,修改TargetFramework和LangVersion为如下形式: <TargetFramework>netcoreapp3.0</TargetFramework>     <LangVersio

NU1101找不到包 NLog。源 Microsoft Visual Studio Offline Packages 中不存在具有此 ID 的

问题:NU1101找不到包 NLog.源 Microsoft Visual Studio Offline Packages 中不存在具有此 ID 的 解决: 一.工具-->Nuget程序包管理器-->程序包管理器设置 二. Nuget Package Manager-->程序包源     三.点击右上角的 加号按钮 ,添加一个新的Nuget源选项     四.名称:随便取            源:https://api.nuget.org/v3/index.json 五.点击右侧的 更