有没有办法将XML注释设置为局部变量?

时间:2017-08-31 04:13:34

标签: c#

简单:有没有办法在Visual Studio中将XML注释设置为局部变量?特别寻找以下(在任何版本的VS中工作)..

如:

/// <summary>
/// Perform editing of multiple HexCells in the HexGrid.
/// </summary>
void EditCells(HexCell center)
{
    /// <summary>
    /// This is the horizontal center of the a cell that I'm working with.
    /// </summary>
    var centerX = center.coordinates.X;

    /// <summary>
    /// This is the vertical center of the a cell that I'm working with.
    /// </summary>
    var centerZ = center.coordinates.Z;

    ...

有没有办法做到这一点?

1 个答案:

答案 0 :(得分:6)

不,XML记录您的本地变量是没有意义的。

XML文档为使用程序集/类/方法的人员提供信息。它不应该通过代码读取。他们无法访问本地变量,因此他们无法访问此文档。

如果您想对那些阅读或维护您的代码的人发表评论,那么您可以使用简单的评论。