如何注释代码 java/c# [关闭]答案

【问题标题】：How to comment code java/c# [closed]如何注释代码 java/c# [关闭]
【发布时间】：2013-06-11 08:50:11
【问题描述】：

告诉我有没有密码

  static private String[][] getRssData(String channel)
 {
     //Code here...
 }

有没有办法让我在悬停时查看功能描述？即添加

 //this is Using to get the RssData

我打算同时使用 c# 和 java 编码来做到这一点

【问题讨论】：

你是说 Javadoc 吗？另见：oracle.com/technetwork/java/javase/documentation/…
你不能通过将 cmets/JavaDoc 添加到你的函数中来做到这一点吗？
我认为他想要一个工具提示类型的小弹出窗口，他可以在编码时查看它。 Javadocs 仅用于后编译，更多的是全局参考，而不是本地化的“这又做了什么？”事物。如果是这种情况，我无能为力。如果没有，Javadocs 是默认的。要走的路。
@RussellUhl 一个现代 IDE 可以立即显示 javadoc。
@ThorbjørnRavnAndersen 很好，这很漂亮。显然，我没有注意。

标签： c# java comments

【解决方案1】：

在 Visual Studio IDE for C# 中，您可以使用 XML Documentation:

///<summary>
///This is used to get the RSS data
///</summary>
///<param name="channel">The channel</param>
///<returns>The RSS data</returns>
private static string[][] GetRssData(string channel)
{
    //...
}

您可以使用 Android Studio (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html) 中的 [Javadoc] 插件在 Java 中执行相同操作：

/**
* This is used to get the RSS data 
* @param channel The channel
* @return The RSS data
*/
static String[][] getRssData(String channel)
{
    //...
}

【讨论】：

【解决方案2】：

有没有办法可以在悬停时查看函数的描述？

这是您使用的 IDE 的功能，而不是语言。如果您在（例如）记事本中查看源代码，您将无法获得悬停文本。

但是（例如）当您将鼠标悬停在源代码中的方法名称上时，Eclipse IDE 可以在弹出窗口中格式化和显示方法的 javadoc cmets。（您无需将 javadoc 后处理为 HTML 即可。Eclipse 会即时从源代码中提取相关注释。）

【讨论】：

我很惊讶其他答案似乎忽略了这一事实。

【解决方案3】：

在 Java 中，Javadoc cmets 是编写文档 cmets 的首选方式。

随便放

/**
 * Your comments go here.
 */

在方法头之前，你的IDE大概可以显示html格式的注释。

此外，您可以使用 javadoc 工具为您的代码生成 html 文档，就像 API 一样。

这是编写好的 javadoc cmets 的指南：http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

【讨论】：

【解决方案4】：

在 C# 中你可以这样做：

/// <summary>
/// this is Using to get the RssData
/// </summary>
static private string[][] GetRssData(string channel)
{
    //Code here...
}

More about <summary>

在 Java 中：

/**
* this is Using to get the RssData
*/
static private string[][] getRssData(String channel)
{
    //Code here...
}

【讨论】：

无论如何用 java 做这个？
@user2279389 我已经编辑了我的答案

【解决方案5】：

在c#中输入///上面的方法和sumarry stub会自动生成

【讨论】：