c# visual studio 摘要

Question

/// <summary>
/// Some Code PLS
/// </summary>
/// <param name="HKEY">0CurrentUser, 1LocalMachine, 2ClassesRoot, 3Users, 4CurrentConfig</param>
/// <param name="keypath">dqw</param>
/// <param name="keyname">dqwq</param>
/// <param name="keyvalue">dw1q</param>
/// <returns></returns>
public static void Create(int HKEY, string keypath, string keyname, int keyvalue)

这是我的 .dll 代码。我在其他项目中使用“using MFG.dll”。我看不到其他项目的摘要。它只显示在dll项目中。

这是在项目中：

Answer 1

您需要将您的评论放在标签的文本中，如下所示：

    /// <summary>
    /// Creates something or other.  
    /// </summary>
    /// <param name="HKEY">0 = CurrentUser, 1 = LocalMachine, 2 = ClassesRoot, 3 = Users, 4 = CurrentConfig</param>
    /// <param name="keypath">The key path.</param>
    /// <param name="keyname">The key name.</param>
    /// <param name="keyvalue">The key value</param>
    public static void Create(int HKEY, string keypath, string keyname, int keyvalue)

我删除了 returns 标签，因为此方法 returns 无效（没有 return 值）。

Answer 2

I cant see summary other project

视觉原因是因为您的 <summary> 标签是空的，它们不会显示摘要。

/// <summary>
/// IM EMPTY!!!
/// </summary>
/// <param name="HKEY">0CurrentUser, 1LocalMachine, 2ClassesRoot, 3Users, 4CurrentConfig</param>
/// <param name="keypath"></param>
/// <param name="keyname"></param>
/// <param name="keyvalue"></param>
/// <returns></returns>

要解决此问题，您需要包含例程的摘要（文本）；您还需要包括您的论点摘要。例如：

/// <summary>
/// My routine!
/// </summary>
/// <param name="HKEY">My HKEY</param>
/// <param name="keypath">The keypath</param>
/// <param name="keyname">The actual keyname</param>
/// <param name="keyvalue">The value of the key</param>
public static void Create(int HKEY, string keypath, string keyname, int keyvalue)

另一件值得检查的事情是您有一个 XML Documentation 文件。如果它丢失了，就没有办法映射它们。

-> 右键单击项目和 select 属性。在属性对话框中，select 构建选项卡，并检查 XML 文档文件。

更多信息，请访问here相关文档。

c# visual studio 摘要

c# visual studio Summarry

c#

summary