Question

Visual Studio做到了;反射器做到了;现在我也想：）

我想检索某些框架程序集中的某些成员的XML文档（即mscorlib.dll，System.dll等）。我认为这将涉及：

查找程序集的XML文件，
导航到适当命名的子元素，
检索所需的项目（<summary>，<remarks>等）

为框架程序集保留的XML文件在哪里？解密XMLDOC命名方案的任何要点？是否有任何库可以使这个过程更容易？

Answer 1

查找xml

对于assembly.dll，它被命名为assembly.xml，但是由Framework SDK安装，Runtime本身不包含.xml文件。用户不需要API文档。

位置有点复杂。它可以与dll并排，位于以当前语言环境命名的子目录中（例如C：\ WINDOWS \ Microsoft.NET \ Framework \ v2.0.50727 \ en），甚至可以在附近的某个奇怪目录中。我建议以运行时查找附属程序集的方式搜索它。

查找元素

要查找元素，您应该从元数据中准备所谓的“xml-doc ID”。 AFAIR以C＃语言规范记录，在MSDN中记录一下。请参阅Processing XML documentation。

Answer 2

基于Ilya's response：

查找xml

.NET fallback locations（忽略GAC和其他不相关的子目录）

static FileInfo GetXmlDocFile( Assembly assembly ) {
  string assemblyDirPath = Path.GetDirectoryName( assembly.Location );
  string fileName = Path.GetFileNameWithoutExtension( assembly.Location ) +".xml";

  return GetFallbackDirectories( CultureInfo.CurrentCulture )
    .Select( dirName => CombinePath( assemblyDirPath, dirName, fileName ) )
    .Select( filePath => new FileInfo( filePath ) )
    .Where( file => file.Exists )
    .First( );
}

static IEnumerable<string> GetFallbackDirectories( CultureInfo culture ) {
  return culture
    .Enumerate( c => c.Parent.Name != c.Name ? c.Parent : null )
    .Select( c => c.Name );
}

static IEnumerable<T> Enumerate<T>( this T start, Func<T, T> next ) {
  for( T item = start; !object.Equals( item, default(T) ); item = next( item ) )
    yield return item;
}

static string CombinePath( params string[] args ) {
  return args.Aggregate( Path.Combine );
}

查找元素

Processing XML Documentation

static XElement GetDocMember( XElement docMembers, MemberInfo member ) {
  string memberId = GetMemberId( member );
  return docMembers.Elements( "member" )
    .Where( e => e.Attribute( "name" ).Value == memberId )
    .First( );
}

static string GetMemberId( MemberInfo member ) {
  char memberKindPrefix = GetMemberPrefix( member );
  string memberName = GetMemberFullName( member );
  return memberKindPrefix + ":" + memberName;
}

static char GetMemberPrefix( MemberInfo member ) {
  return member.GetType( ).Name
    .Replace( "Runtime", "" )[0];
}

static string GetMemberFullName( MemberInfo member ) {
  string memberScope = "";
  if( member.DeclaringType != null )
    memberScope = GetMemberFullName( member.DeclaringType );
  else if( member is Type )
    memberScope = ((Type)member).Namespace;

  return memberScope + "." + member.Name;
}

使用示例

Type type = typeof( string );

var file = GetXmlDocFile( type.Assembly );
var docXml = XDocument.Load( file.FullName );
var docMembers = docXml.Root.Element( "members" );

var member = type.GetProperty( "Length" );
var docMember = GetDocMember( docMembers, member );

Answer 3

我在CodePlex上维护Jolt.NET项目，并实现了执行此任务的功能。有关详细信息，请参阅Jolt库。

本质上，库允许您使用System.Reflection中的元数据类型（即MethodInfo，PropertyInfo等以编程方式查找和查询程序集的XML文档注释文件。）。

Answer 4

尝试DocsByReflection。

// From method.
var methodInfo = typeof(Stub).GetMethod("MethodWithGenericParameter");
var methodDoc = DocsService.GetXmlFromMember(methodInfo);

Answer 5

这是一个现成的库，可以让你这样做：NuDoc http://kzu.to/nudoc

例如，阅读mscorlib上的整个文档将非常简单：

var members = Reader.Read(typeof(string).Assembly);

您可以稍后使用简单的访问者处理结果，如网站所示。

我正在利用该库生成一个API站点，使用markdown在GitHub中进行托管，理想情况下是自动生成每个版本，甚至可能是wiki，因此它可以更新并往返代码:)

Answer 6

XML文件的名称与程序集的文件完全相同，但不同的“xml”扩展名除外，并且必须与程序集本身位于同一目录中。

但是，对于其他两个问题，无法帮助您。 AFAIK，你自己......

以编程方式检索xml doc注释

6 个答案: