akkadotnet/akka.net

Improve missing or boilerplate xmldoc

Open

#647 建立於 2015年2月19日

在 GitHub 查看
 (14 留言) (0 反應) (0 負責人)C# (4,543 star) (1,035 fork)batch import
docshelp wantedup for grabs

描述

A lot of the xmldoc is great, succinct and very informative. However there is still giant swathes of missing or bolierplate xmldoc that could be greatly improved. Most of the bolierplate comments look to be auto-generated from a tool like GhostDoc.

Not to pick on one class in particular, but if you take a look at for example src/core/Akka/Configuration/ConfigurationFactory.cs you'll notice some hilariously bad xmldoc.

/// <summary>
///     Gets the empty.
/// </summary>
/// <value>The empty.</value>
public static Config Empty
{
    get { return ParseString(""); }
}

/// <summary>
///     Defaults this instance.
/// </summary>
/// <returns>Config.</returns>
public static Config Default()
{
    return FromResource("Akka.Configuration.Pigeon.conf");
}

/// <summary>
///     Froms the resource.
/// </summary>
/// <param name="resourceName">Name of the resource.</param>
/// <returns>Config.</returns>
internal static Config FromResource(string resourceName)
{
    Assembly assembly = Assembly.GetExecutingAssembly();

    return FromResource(resourceName, assembly);
}

I know there are more pressing issues at hand, but it would be nice to have clean API docs :)

貢獻者指南