我喜欢intellisense,我认为每个人都应该总是在类和方法上添加结构化的评论,我之所以这么说是因为存在"自我评论代码"本身就是一种错误的做法。
你如何在创作者明显的东西之间划清界线,但对于其他任何开发者来说都不是这样?
在我的公司,我们有很多非常有用的共享NuGet包,但是大多数都没有注释,或者至少在接口中没有注释。这导致消费者类使用IoC盲目地使用完全失去评论的界面,因此智能感知。
也许我没有以正确的方式创建NuGet包,但到目前为止,我发现的最佳实践是在界面中添加注释并添加实现类,注释:{'deposit_id': 1117, 'deposit': 106.3, 'name': 'John', 'time': 1234}
{'deposit_id': 1118, 'deposit': 95.3, 'name': 'John', 'time': 1235}
{'deposit_id': 1119, 'deposit': 95.3, 'name': 'Lisa', 'time': 1235}
。
这有助于我分享文档,参数和返回类型描述等。 现在,inherithdoc主要用于生成XML文档,但在从实现类访问描述时却没有用。
一个例子,我有IMyClass的所有好评,如果我打开实现IMyClass的MyClass,我可以通读代码,但我不能直接访问评论,这是非常烦人的被迫来回跳转到接口以便阅读它们。
所以一个可能的解决方案是跨接口复制注释并实现类,但我讨厌复制,你可以很容易地在这里更新描述,但不是那里。
所以我对社区的问题是,你如何处理这个问题?是否有任何扩展显示我的描述可能作为代码的一部分? 将鼠标悬停在cref属性上,允许我获取类/接口和方法的描述,但不能获取参数。