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

Question

сказать, если у меня есть код

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

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

//this is Using to get the RssData 

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

Answer 1

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

Answer 2

В 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... 
} 

Answer 3

В интегрированной среды разработки Visual студии для 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) 
{ 
    //... 
} 

Вы можете использовать с [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 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 извлекает соответствующий комментарий из исходного кода на лету.)