为什么我需要在C#/ .Net代码中使用这些讨厌的注释？

Question

我正在构建应用程序,其中一个要求是使用类似这样的注释:

/// <summary>
/// Creates new client.
/// </summary>
/// <param name="uri">The URI.</param>
/// <param name="param">The param.</param>
/// <returns></returns>

据我所知,各种工具很容易根据这些xmls生成文档.但它显着降低了代码的可读性,而这正是我们人类试图实现的目标.

这种方法可以被.Net中的任何其他技术取代吗？什么是提高代码可读性和清洁度的更好方法？

Answer 1

当有人在通过你的方法时使用intellisense时,这些信息应该出现在visual studio上.这将节省时间,因为无论谁使用您的代码都不需要进入您的代码(这意味着您也不需要公开任何代码)并查看您编写的其他注释.

我认为文档在保持简短和重要的时候从来都不是坏事,它不会影响代码的可读性.