有没有一个标准(如phpdoc或python的docstring)评论C#代码?

发布时间:2022-04-30 发布网站:脚本宝典
脚本宝典收集整理的这篇文章主要介绍了有没有一个标准(如phpdoc或python的docstring)评论C#代码?脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。
有没有一个标准约定(如PHPdoc或 python的docstring)来评论C#代码,以便可以从代码自动生成类文档?
您可以使用 XML样式的注释,并使用工具将这些注释引入api文档.

这是一个评论风格的例子:

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True,if authentication is successful,otherwise False.
/// </returns>
/// <remarks>
/// For use wITh local systems
/// </remarks>
public override bool Authenticate(string username,string password)

有些项目是为了促进这一点

GhostDoc,它为单个快捷键提供一个类或方法自动生成注释.
Sandcastle,它从XML注释生成MSDN样式文档.

脚本宝典总结

以上是脚本宝典为你收集整理的有没有一个标准(如phpdoc或python的docstring)评论C#代码?全部内容,希望文章能够帮你解决有没有一个标准(如phpdoc或python的docstring)评论C#代码?所遇到的问题。

如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典推荐好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。