[.NET编程]如何使用VS找到XML注释文档

许多引用的程序集(包括官方和第三方)都有XML注释文档,本教程指导如何找到XML注释文档文件所在的位置并说明知道这些可以做到什么。

一、注释文档体现在什么地方

在编写代码的时候,IDE会显示类型成员的相关说明,如图所示。

这些说明可以帮助我们找到所需要的类型或成员,并知道类型或成员的作用和使用方式是什么。可以极大的节省编写代码所需要的工作和时间。

二、为什么要找到注释文件

这些注释是程序集提供者所提供的,虽然其他人也可以编写这些文档,但绝大多数还是有程序集提供者直接提供。而因此,经常出现注释文档语言不通的情况。例如上图中的注释为英文。如果我们可以找到这些注释文件,那么我们便可以分析其格式,将其翻译成我们所知的语言然后放入可识别的位置。

三、如何找到注释文件

找到注释文件非常简单,只需要在成员位置处右键单击,选择「转到定义」菜单(或直接按其快捷键「F12」)可跳转到其类型定义页面。

类型定义页面最上方显示程序集名称和其版本等信息,双击程序集信息可将其展开,下方会有一条注释信息显示的是程序集文件的位置。

在资源管理器中找到此文件,注释文件通常就是同名的XML文件。

有些程序集本身就支持多个语言,XML注释文件也可能会在相对应语言的文件夹内。

上图中的 zh-CN 表示中文简体,下面是一些常用的语言名称:

zh : 中文(Chinese)

zh-CN : 中文(简体,中国)(Chinese (Simplified, China))

zh-Hans : 中文(简体)(Chinese (Simplified))

zh-Hans-HK : 中文(简体汉字,中国香港特别行政区)(Chinese (Simplified Han, Hong Kong SAR))

zh-Hans-MO : 中文(简体汉字,中国澳门特别行政区)(Chinese (Simplified Han, Macao SAR))

zh-Hant : 中文(繁体)(Chinese (Traditional))

zh-HK : 中文(繁体,中国香港特别行政区)(Chinese (Traditional, Hong Kong SAR))

zh-MO : 中文(繁体,中国澳门特别行政区)(Chinese (Traditional, Macao SAR))

zh-SG : 中文(简体,新加坡)(Chinese (Simplified, Singapore))

zh-TW : 中文(繁体,中国台湾)(Chinese (Traditional, Taiwan))

zh-CHS : 中文(简体) – 传统用法(Chinese (Simplified) Legacy)

zh-CHT : 中文(繁体) – 传统用法(Chinese (Traditional) Legacy)

en : 英语(English)

en-001 : 英语(全球)(English (World))

en-GB : 英语(英国)(English (United Kingdom))

en-US : 英语(美国)(English (United States))

可使用以下代码获取所有语言名称:

将翻译后的文件替换掉原文件或者放入当前语言文件夹下均可生效(语言文件夹需要编辑器支持)。

四、如何翻译注释文档

可自己打开注释文件手动翻译或编辑,也可以使用我编写XML注释文档翻译工具。

翻译工具完全开源、完全免费,但需要注册百度翻译API帐号。百度翻译API标准版是不限字数免费使用的(但请注意百度官方收费政策调整)。

直接下载地址:https://github.com/Himesyo/QuickTranslation/releases/download/Release_v1.0.1/QuickTranslation_v1.0.1.zip

所有发布地址:

https://github.com/Himesyo/QuickTranslation/releases

源代码:

https://github.com/Himesyo/QuickTranslation

资源下载: