为开发者发现性编写 API 的方法

发布于 2024-10-12 11:10:39 字数 1432 浏览 3 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

月下凄凉 2024-10-19 11:10:39

使用内联 XML 注释,并使用 SandCastle 以编程方式生成在线文档。它不是“自我记录”,但它是创建文档时尽可能低的摩擦。

您可以使用 StyleCop 强制执行此操作(以及其他好东西)。如果您使用 Resharper,您甚至可以使用 StyleCop for Resharper 插件实时强制执行此操作。

Use inline XML comments, and generate online documentation off them programmatically with SandCastle. It's not "self-documenting", but it's about as low-friction as you can get for creating documentation.

You can enforce this (and other good stuff) using StyleCop. If you're using Resharper, you can even enforce this in realtime with the StyleCop for Resharper plugin.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文