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

Question

很难说出这里问的是什么。这个问题是含糊的、模糊的、不完整的、过于宽泛的或修辞性的，无法以目前的形式得到合理的回答。如需帮助澄清此问题以便重新打开它， visit the help center 。

已关闭 10 年前。

如果我有代码

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

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

 //this is Using to get the RssData

我打算使用 C# 和 Java 编码来实现此目的

Answer 1

在适用于 C# 的 Visual Studio IDE 中，您可以使用 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 中的 [Javadoc] 插件 ( http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html ) 在 Java 中执行相同的操作:

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