c# - 如何注释代码 java/c#

Question

说我有没有密码

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

有没有办法可以查看悬停时的功能描述？即添加

 //this is Using to get the RssData

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

Answer 1

在 C# 的 Visual Studio IDE 中，您可以使用XML 文档：

///<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)
{
    //...
}

Answer 2

在上面的 c# 中键入///方法和 sumarry 存根将自动生成

Answer 3

在 C# 中，您可以这样做：

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

更多关于<summary>

在 Java 中：

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

Answer 4

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

就放

/**
 * Your comments go here.
 */

在方法标头之前，您的 IDE 可能会显示 html 格式的注释。

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

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

Answer 5

有没有办法可以查看悬停时的功能描述？

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

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