java - 添加到我的方法快速文档描述(android studio)

Question

有没有办法在方法快速文档中添加描述？我创建了一些方法，计划稍后使用，并希望添加到其快速文档中，以提醒自己该方法的用途，以防万一我忘记了，而不必进入方法本身来阅读描述内容的注释该方法确实如此。

Answer 1

Is there a way to add to a description in a methods quick documentation?

记录方法的最佳方法是为它们(及其参数)指定有意义的名称。

注释不应重复代码本身所表达的内容。但没有任何生成器会深入你的大脑并从中提取你的 Intent 。相反，它会分析代码并根据已编写的内容构建注释。
因此无法生成(有意义的)评论。

您应该(自己)撰写评论有两个正当理由:

1. 接口(interface)

   接口(interface)需要(JavaDoc)注释来解释方法背后的契约，以表达调用者对实现者的帮助的期望。

2. 奇怪的球解决方案

   您的代码中是否有某些内容以不寻常的方式完成？ 然后添加评论为什么你这样做。

也可能出于法律原因提出评论，例如版权标记、许可文本等。但除此之外不应该有任何其他评论，尤其是没有生成任何评论。