首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何从我的C#XML文档注释中链接到MSDN /官方文档?

从C# XML文档注释中链接到MSDN /官方文档,可以使用以下方法:

  1. 使用<see>标签:

<see>标签可以在注释中创建一个指向另一个类型或成员的超链接。例如,如果要链接到MSDN上的一个类型或成员,可以使用以下语法:

代码语言:csharp
复制
/// <see cref="System.IO.FileStream"/>

这将在注释中创建一个指向System.IO.FileStream类型的超链接。

  1. 使用<seealso>标签:

<seealso>标签的用法与<see>标签类似,但它通常用于在注释的底部创建一个超链接。例如:

代码语言:csharp
复制
/// <seealso cref="System.IO.FileStream"/>

这将在注释底部创建一个指向System.IO.FileStream类型的超链接。

  1. 使用<a>标签:

如果需要创建一个指向MSDN上的特定文档页面的超链接,可以使用<a>标签。例如:

代码语言:csharp
复制
/// <a href="https://docs.microsoft.com/en-us/dotnet/api/system.io.filestream?view=net-6.0">FileStream</a>

这将在注释中创建一个指向FileStream类型MSDN文档页面的超链接。

  1. 使用<paramref>标签:

<paramref>标签可以在注释中创建一个指向方法参数的超链接。例如:

代码语言:csharp
复制
///<paramref name="filename"/>

这将在注释中创建一个指向filename参数的超链接。

  1. 使用<typeparamref>标签:

<typeparamref>标签可以在注释中创建一个指向泛型类型参数的超链接。例如:

代码语言:csharp
复制
/// <typeparamref name="T"/>

这将在注释中创建一个指向泛型类型参数T的超链接。

总之,可以使用上述方法在C# XML文档注释中链接到MSDN /官方文档。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

教你如何快速从 Oracle 官方文档中获取需要的知识

以下链接可查看 11g 到 20c 的在线官方文档。...https://docs.oracle.com/en/database/oracle/oracle-database/index.html 如图,以上从 7.3.4 到 20c 的官方文档均可在线查看...:https://docs.oracle.com/cd/E11882_01/server.112/e40402/toc.htm 这里以 11g R2 官方文档为例: 今天来说说怎么快速的从官方文档中得到自己需要的知识...在线官方文档地址: http://tahiti.oracle.com/ 几乎囊括了 oracle各种产品的文档 离线下载地址: www.oracle.com 这个不多说了 以11g官方网文档为例: Getting...最好的参考书,最好的资料就是官方文档了,掌握官方文档查询方法提高学习效率。 好了,目前就先说这么多吧,后面遇到问题在一起说吧。

7.9K00

【Tip】如何让引用的dll随附的xml注释文档、pdb调试库等文件不出现在项目输出目录中

其中xml是同名dll的注释文档,pdb是调试库。我们最终应该只想要exe和dll,除了手工删,我知道的有两招,可以让项目生成后,xml和pdb不会出现: 1、利用项目【生成事件】。...x*.xml 有个问题,对web项目没用,就是本地bin目录中是没了,但服务器上的bin目录会有。...我猜测web项目的发布动作并不是先生成在本地bin,完了再拷过去,而是有可能先生成在一个临时目录,完了再从临时目录分别拷到bin和远端,所以只删bin中的无济于事,关键是删临时目录,我猜测是obj目录,...我此前一直用的就是这招,直到今天学到了下面的新招。 2、在项目csproj文件加入元素节点AllowedReferenceRelatedFileExtensions。...AllowedReferenceRelatedFileExtensions从名称上就能看出,它就是专门用来干这个的(相比,生成事件能做的事更多),父元素PropertyGroup通常分Debug和Release

1.6K30
  • 火眼(FireEye)实验室FLARE IDA Pro脚本系列:MSDN注释插件

    ,我的目标是开发一个IDA python插件,用于加快在IDA Pro中的逆向工作流程。‍‍‍和团队一起分析恶意代码样本时,我意识到从MSDN网站上查找函数、参数和常量等信息占用了大部分时间。...二、介绍 ‍‍‍‍MSDN注释插件整合了函数、参数、返回值等信息,并以注释的形式呈现在IDA Pro反汇编列表中,尽可能的实现了信息的无缝整合。...表1:标准符号常量的自动化标记 ‍‍‍‍在图1中,你能清楚地看到该插件在反汇编代码中如何显示函数、参数以及常量信息。...额外添加到IDA数据库的段 ‍‍‍‍.msdn段中存储了参数的描述信息,如图4所示。独一无二的参数名和相应描述性的注释被顺序的添加到该段中。‍‍‍‍ ? 图4....脚本需要TIL文件的目录(通常为%IDADIR%/til/pc/)和已解压的MSDN文档的目录。当脚本运行完之后,最终的XML数据库文件就位于MSDN_data 目录中。‍‍‍‍

    3.2K90

    Visual Studio 2008 每日提示(二)

    ); 按下快捷键:Shift + Alt + Enter可以迅速的从其他三种窗口布局切换到全屏模式。...评论:除非自己特别常用的,我一般都是用默认的快捷方式 #017、 使用快捷键来注释和取消注释 原文地址:http://blogs.msdn.com/saraford/archive/2007/08/16...你也可以使用菜单:编辑+高级+注释选定内容 或编辑+高级+取消注释选定内容 如果你想使用不同的快捷键,可以参照#016 评论:这个我经常用,其实只要把光标放在需要注释行的最前面,使用快捷键就可以注释当前光标所在行的代码...我非常喜欢这个格式化文档的功能,排版和缩进都一下搞定 #019、 转换代码中的空格和Tab字符 原文地址:http://blogs.msdn.com/saraford/archive/2007/08/21...-高级-将选定行中的空格转换为制表符(TAB) 将选中行开头的空白字符转换为空格字符:菜单)编辑-高级-将选定行中的制表符(TAB)转换为空格 评论:为了保持格式的统一,我一般喜欢把制表符设置成空格,

    1.4K80

    GO 文档笔记

    前言 最开始写 GO 的时候, 发现方法的注释并不支持@param, @return等参数, 搞得我都不知道该如何给自己的方法写文档说明了. 而且网上搜了搜也没有搜到教程, 甚是郁闷....可以直接在本地浏览器访问8888端口, 查看这个运行在本地的文档服务: localhost:8888. 能够看到所有官方包的文档. 而这些文档内容都是从官方代码包中读取的....image-20200719145327838 既然人家官方代码能生成文档, 那就说明是有文档生成格式的呀. 既然我不知道如何写文档, 抄官方的样式不就行了么? nice....以下是我多处借鉴后, 总结的 GO 文档书写规则. 文档 经过测试, GO 的文档格式, 全局变量/常量/函数/结构体/接口/包等等, 声明格式都一样, 会读取对应内容上方紧跟着的注释内容....对于包的说明文档, 因为包下每个文件都有package doc 这段代码, 如果包下有多个文件都对此包进行了说明, 文档会将所有说明拼接到一起.

    1.1K40

    使用并解析 OPML 格式的订阅列表来转移自己的 RSS 订阅(概念篇)

    其中最后一行的描述即交换订阅,尤其是 RSS 订阅。 典型的 OPML 文件 为了直观地了解 OPML 格式,我直接贴一个我的订阅的极简版文件内容。 中包含 title,body 中包含分组的 outline。每一个 outline 中包含 text, type, xmlUrl 等属性。...文档作者 ownerEmail 文档作者的邮箱 ownerId 文档作者的 url,要求不存在相同 Id 的两个作者 docs 描述此文档的文档的 url 当然,这些都是可选的。...在前面的例子中,我把自己的 RSS 订阅独立开来,把朋友和微软的 RSS 订阅分成了单独的组。 outline 必须有 text 属性,其他都是可选的。...在官方规范中,规定解析器不应该总认为 text 存在,相比之下,xmlUrl 显得更加重要。

    4.9K20

    Excel催化剂开源第22波-VSTO的帮助文档在哪里?

    帮助文档书籍 在Excel对象模型的文档里,貌似是英文的 对于.Net的类库资料,还是有人工翻译的 同样VSTO的宿主项的信息,也已经人工翻译的 然后顺着在帮肋文档里跳转出来的其他链接,可以看到msdn...但遗憾的是,从OFFICE2013之后,不再有离线版的开发文档,并且不再有中文的开发文档。...离线版Excel开发帮助文档 结语 进入VSTO开发的领域,不能单靠一些图书的方式获取帮助,更多地应该是从官方文档中获取信息,再辅助用搜索引擎。...官方文档的查看,对一些新手来说,还是有些障碍,此篇带给大家帮助文档的查看的一些技能。...用上官方的帮助文档,可以瞬间发现,其实VSTO的学习资源已经非常丰富,并不像我们印象中那样只用一点点的网络资源和图书资源。

    1.2K30

    RustChinaConf 2022 大会议题回顾 | Part I : Rustdoc 你可以用它做什么以及它的未来

    我的最终目标是使文档的编写尽可能简单,以便所有项目都有很好的文档 Rustdoc是官方的Rust工具,可以为你的crates生成文档。...如何用 rustdoc 创建文档 在 Rust 里可以通过基本的文档注释 /// 和 //!来创建文档, Guillaume 在演讲视频中也做了演示,因为这是最基本的语法,本文里就不做过多介绍。...使用 rustdoc 进行文档测试 文档注释中的代码示例,可以通过 cargo test来运行,这是 rustdoc 提供的文档测试功能。...pub struct Bar; use std::sync::mpsc::Receiver; // rustdoc 支持链接到 标准库文档中的类型 /// This is a version of...文档注释工作机制 代码中的文档注释 /// 在编译时会被 #[doc] 属性替换。

    59220

    用Python处理Excel文件

    这应该是个比较新的项目,在GitHub上看它最早的提交是在2013年1月份。其官方文档中宣称它支持: 100% compatible Excel XLSX files....我的程序最终的版本也依然用xlrd从已有的文件中读出所需的信息。 xlrd&xlwt主要是针对Office 2013或更早版本的XLS文件格式。...优点 一、最大的优点:强大无极限 因为直接与Excel进程通信,你可以做任何在Excel里可以做的事情。 二、文档丰富 MSDN上的文档绝对是世界上最优秀的文档。没有之一。...关于初始化 Excel的com接口的具体细节我就不介绍了,需要的话直接查阅相关的MSDN文档即可。这里只提几个特殊的小问题。...,可以查阅MSDN中Excel Enumerations相关的资料。

    2.8K20

    探索基于VSCode的远程开发插件,进行远程指令和本地指令的运行

    并且在开发过程中,能够使用几乎所有的VSCode插件。...当你使用这个插件链接到远程机器,并打开一个工作目录时,那么终端的命令是默认在当前的工作目录, 需求是,当是远程工作目录时,也能够够创建一个终端,而这个终端的工作目录是本地工作目录。...你可以这样创建终端,将工作目录中的子级当做终端的工作目录。...但是当vscode链接到远程工作目录后,该方法就不能正常执行了。 这里我存在两个问题, 创建中的cwd参数到底支不支持本地机器的路径? 如何支持,那路径应该如何写?...目前还没找到答案,我想最终答案肯定是不支持的,如果支持这样重要的特性,官方一定会在文档中注明的。但我翻了很多文档却没找到。 在查询文档时也看到了很多额外的东西,不管有没有用,都记录一下吧。

    39920

    SQL Server中网络协议的比较与选择

    若要配置未在 SQL Server 配置管理器中出现的 TCP/IP 设置,请参阅 Microsoft Windows 文档。...以前使用这些协议连接的客户端必须选择其他协议才能连接到 SQL Server。 有关如何配置协议和连接到数据库引擎的简短教程,请参阅教程:数据库引擎入门。...它一般用于局域网中,因为它要求客户端必须具有访问服务器资源的权限。 要解释这个问题,我还是摘录微软官方的资料比较好(见上面“SQL Server中网络协议”) 2. 为什么用命名管道?...要使用命名管道连接到SQL Server,客户端代码中的连接字符串大致的语法是这样的 "server=..../zh-cn/library/ms187892.aspx (微软官方) SQL Server Native Client 编程: http://msdn.microsoft.com/zh-cn/library

    1.6K20

    Visual Studio 2008 每日提示(六)

    操作步骤: 在编辑器里,如果存在链接,如何单击URL后在ide内置的浏览器中定位(转到)到相应链接,设置方法如下: 菜单:工具+选项+文本编辑器+所有语言+常规,选中”启用单击URL定位”项。...按Ctrl同时单击链接,就可以在新的文档窗口打开链接。 评论:无论是注释中还是代码中带有链接,都可以,但链接必须包括”http://”。不过我觉得这个功能我用的不多,我很少在vs里面打开网页。...操作步骤: “右键”单击工具栏任意位置,在“上下文菜单”中选择“自定义”,在“工具栏”标签中选中左下角的“在屏幕提示中显示快捷键”。.../2007/10/11/did-you-know-you-can-resize-the-statement-completion-window.aspx 操作步骤: 你可以通过鼠标的拖动从各个方向来改变...评论:呵呵,这个我觉得调整的必要不大 #060、在语句完成窗口使用键盘切换“通用”和“所有”标签页 原文地址:http://blogs.msdn.com/saraford/archive/2007/10

    957100

    『Dva』路由

    那么本篇文章呢,我就来继续介绍下在 dva 中如何使用路由。 二、Dva 中的路由 2.1 搭建使用路由环境(新增多个组件) 在 dva 中如何使用路由呢?...2.2 使用路由 要想使用它就得要先导入 dva 封装好的路由,从哪导入呢,从 dva 的 router 当中导入,我这里采用解构的方式解构出想要的内容,在 dva router 中,它给我们封装好了一个...也很简单,继续看官方文档找到 app.router 的方法文档,也就是 dva 的 router 文档: 过去我们是不是在代码中通过 router 将来我要渲染哪个组件,如下这段代码: 其实在告诉 dva...hash 模式,前说过了,这些内容我都是怎么知道的我都是从文档里面抄的,官方文档也是解构当前的模式,然后将模式告诉 Router: 回到网页刷新一下,就不会报错了,路径地址后面有一个 # 号,是不是意味着当前是...是不是还是回到官方文档当中找到创建 dva 实例对象的代码,已经告诉我们如何操作了,首先得要导入 createHistory 这个方法: import createHistory from 'history

    9530

    EVC34项目升级到Visual Studio项目的一些建议

    其实,按照微软官方的说法,EVC 4已经不能开发Windows Mobile 6.0以上的应用程序了,取而代之的是使用Visual Studio 2005/2008。...注意的是要在头文件和.cpp文件中都进行修改,使得其一致。同时,在函数体中,进行return相应的值。因为需要返回LRESULT值。 3....以我为例,这个异常出现在winmain.cpp中, ?     原因是InitInstance()返回不成功,于是我再进入InitInstance函数查看。...目前为止,我暂时碰到的问题还只有以上这些。如果还有问题的话,我会继续总结。     另外,MSDN文档和前辈的一些文章给了我很好的参考,在此给出链接,希望对大家有用。...从 MFC 3.0 升级到 8.0 后不受支持的 eVC 类的列表 3. 从 eVC 移植所带来的已知问题 4. 也谈EVC工程移植

    1.1K100

    Visual Studio 2008 每日提示(五)

    操作步骤: 1、向后删除:Ctrl+Delete ,从光标处向后删除到单词结束 2、向前删除:Ctrl+Backspace,从光标处向前删除到单词开始 评论:这个功能值得推荐,可以很快速的删除一个单词或一部分字符...评论:这两个快捷功能,我最喜欢了,不必手动选择一行,只要把把光标放在一行的任意位置就可以实现剪切和删除 #047、在选中代码段交换光标的位置 原文地址:http://blogs.msdn.com/saraford...操作步骤: 当光标在编辑器中时,你会在标准工具栏里发现“撤销”和“重复”的按钮。...如何避免这种情况的出现呢?可以进行如下设置: 菜单:工具+选项+文本编辑器+所有语言,不勾选“没有选定内容时对空行应用剪切或复制命令”。 清除此选项时,“剪切”命令将移除空行。...但仍保留剪贴板中的数据。因此,如果随后使用“粘贴”命令,则会粘贴最近复制到剪贴板的内容。如果先前没有复制任何内容,则不会粘贴任何内容。 评论:使用这个功能就可以避免粘贴空行了。

    87860

    MFC中的CListCtrl的最左边一列必须左对齐吗?

    好久不写MFC的程序了,很多细节问题都记不清了,今晚无意中要用到CListCtrl控件,希望能够表头采用自己绘制的方式显示,于是自己编写了OnPaint方法进行重绘,过程中需要根据每一列的对齐方式进行绘制表头中的标题文字...CListCtrl中插入列的时候,第一列我设置成了剧中对齐,但是结果无论如何都得不到正确的结果,偏偏其他列我又是设置的左对齐,所以结果所有列都是左对齐,于是我认为是不是GetItem没有取得对齐方式的数据...,结果到MSDN中寻找帮助,结果一无所获,后来想想是不是我的MSDN太旧了,就到微软的MSDN网站查看帮助文档,结果在说明中发现了这样一句话: Remarks The leftmost column in...不觉感叹道:这是谁规定的啊?真是不地道。 于是问题又来了,如果让第一列能够做到剧中对齐呢?通过实验发现在InsertColumn的时候第一个参数就是列的索引,取值从1开始,这样就可以解决问题了。...文档中并没有提及这个问题,想想文档的不细致给使用者带来了如此的麻烦,相信也有很多人遇到了这个问题,希望这个小小的博客能够帮助大家节省时间。

    1.4K60
    领券