如何在XML文档中引用C＃关键字？
例如， <see cref="switch" />不起作用 – 我收到编译警告： XML comment on ... has syntactically incorrect cref attribute 'switch'
对于那些有兴趣的人来说，
/// <summary>Provides base functionality for hand-coded abstractions of API method wrappers, mostly those that abstract over /// parameters that are required to be JSON-encoded.</summary> public class FacebookArgs : Dictionary<String, Object> { /// <summary>Initializes an instance of <see cref="FacebookArgs" />.</summary> public FacebookArgs() { } /// <summary>Intializes an instance of <see cref="FacebookArgs" />, that contains elements copied from <paramref name="dictionary "/>.</summary> /// <param name="dictionary"></param> public FacebookArgs(IDictionary<String, Object> dictionary) : base(dictionary) { } /// <summary>Gets or sets the value associated with the specified key.</summary> /// <param name="key">The key of the value to get or set.</param> /// <returns>The value associated with the specified key.</returns> /// <remarks>This implementation hides the base indexer implementation such that specifying a key that does not exist returns null rather than throwing a <see cref="KeyNotFoundException" />.</remarks> public new Object this[String key] { get { Object value; if (this.TryGetValue(key, out value)) return value; else return null; } set { base[key] = value; } } /// <summary>In derived classes, provides specialized serialization logic for specific properties contained in this object.</summary> /// <param name="key">The key of the property to serialize.</param> /// <param name="args">A reference to a dictionary of arguments that will be passed directly to a <see cref="FacebookRequest" /> object.</param> /// <remarks> /// <para>This method allows specialized serialization logic, such as JSON encoding, to be applied to specific properties.</para> /// <para>To implement, use a <c>switch</c> (<c>Select</c> in VB.NET) statement to filter based on <paramref name="key" /> and provide the property-specific logic. /// The resulting value should then be added to <paramref name="args" /> using the same <paramref name="key "/>. /// </para> /// <para>Properties that do not require additional processing (strings, integral values, etc) should be ignored.</para> /// </remarks> protected virtual void SerializeProperty(String key, ref IDictionary<String, Object> args) { } /// <summary>Returns a dictionary of key/value pairs suitable to be passed a <see cref="FacebookRequest" /> object.</summary> /// <returns>A dictionary of key/value pairs suitable to be passed a <see cref="FacebookRequest" /> object.</returns> /// <remarks>This method calls the <see cref="SerializeProperty" /> for each key in the object, which allows property-specific processing /// to be done on any property.</remarks> /// <seealso cref="SerializeProperty" /> public IDictionary<String, Object> GetArgs() { IDictionary<String, Object> args = new Dictionary<String, Object>(); foreach (String key in this.Keys) { this.SerializeProperty(key, ref args); if (!args.ContainsKey(key) && this[key] != null) { args.Add(key, this[key]); } } return args; } }
有问题的标签可以在SerializeProperty的<remarks>标签中find。 我犯了冗长的文档。 我也打算提供一些<example> ，我还没有得到它。
cref是为了引用另一个成员 – 一个类，一个方法等
在这种情况下，你期望它链接到什么？ 一般来说，你想要什么样的整体效果呢？
根据这个优秀的XML文档指南 ， <see>标签有一个未langword属性langword ：
<see langword="switch" />
会帮助你吗？ 这可能是值得尝试一下，看看它做了什么。
如果您只想使用正常的超链接，请使用href而不是cref：
<see href="http://msdn.microsoft.com/en-us/library/06tc147t.aspx">switch</a>
