Как комментировать код java/ C#

Question

Скажи если у меня есть код

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

Есть ли способ, которым я могу просмотреть описание функции при наведении курсора? т.е. добавление

 //this is Using to get the RssData

Я намерен сделать это с помощью C# и Java-кодирования

Answer 1

В Visual Studio IDE для C# вы можете использовать документацию 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)
{
    //...
}

Вы можете использовать с плагином [Javadoc] в Android Studio ( 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)
{
    //...
}

Answer 2

В 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 3

В Java комментарии Javadoc являются предпочтительным способом написания комментариев к документам.

Просто положи

/**
 * Your comments go here.
 */

Перед заголовком метода и вашей IDE, вероятно, могут отображаться комментарии в формате html.

Кроме того, вы можете использовать инструмент javadoc для генерации HTML-документации для вашего кода, точно так же как API.

Вот руководство по написанию хороших комментариев на Javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 4

В типе C# /// выше метода и суррогатная заглушка будет автоматически сгенерирована

Answer 5

Есть ли способ, которым я могу просмотреть описание функции при наведении курсора?

Это функция IDE, которую вы используете, а не язык. Если вы посмотрите на свой исходный код в (скажем) Блокноте, вы не сможете получить текст при наведении курсора.

Но (например) Eclipse IDE может форматировать и отображать комментарии javadoc метода во всплывающем окне, когда вы наводите указатель мыши на имя метода в исходном коде. (Вам не нужно пост-обрабатывать Javadoc в HTML, чтобы это произошло. Eclipse извлекает соответствующий комментарий из исходного кода на лету.)