添加到我的方法快速文档描述（android studio）

Question

有没有办法在方法快速文档中添加说明？我有一些我创建的方法，我打算稍后在线上使用，并希望添加到其快速文档中以提醒自己在忘记的情况下该方法是什么，而不必进入方法本身来阅读描述内容的注释方法确实如此。

Answer 1

  

有没有办法在方法快速文档中添加描述？

记录方法的最佳方法是为它们（及其参数）提供有意义的名称。

注释不应重复代码表达的内容。但是没有发电机能够从头脑中探出你的意图。它宁愿分析代码并根据已编写的内容构建注释 因此，无法生成（有意义的）评论。

为什么你应该写自己的评论有两个正当理由：

1. 接口

   接口需要（JavaDoc）注释来解释方法背后的契约，以表达调用者期望作为实施者的帮助。

2. 奇球解决方案

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

出于法律原因，可能还会发表评论，例如版权标记，许可文本等。但是那时候不应该有任何其他评论，特别是没有产生。

Answer 2

如果您想将评论放在整个项目的单个位置，或者将评论与一组文件放在一起，请尝试使用自述文件。这些通常用Markdown编写，以便于转换为格式精美的HTML，以便于阅读。试试online markdown editor。