/ * и / ** для javadoc - просто Eclipse или это соглашение Java?

Question

Я заметил, что в Eclipse, когда я использую

/*
 * My Comment
 */
public class myClass {

}

«Мой комментарий» не ассоциируется с классом, но

/**
 * My Comment
 */
public class myClass {

}

«Мой комментарий» делает

Аналогично

/** myComment */
public static final String MY_VARIABLE = "testing";

также ассоциируется с Javadoc.

Является ли это Eclipse или частью системы документирования java.

Должен ли я всегда использовать / ** в отличие от / *?

Answer 1

Это то, как Javadocs хочет получить комментарии, а Javadoc является отраслевым стандартом де-факто. ( Sun's Как написать документ Комментарии )

Другие инструменты, такие как doxygen, также поддерживают стиль Javadoc, поэтому вы всегда должны использовать /** для комментариев, документирующих класс, метод или переменную при разработке в Java, если нет веских причин для иного. Для общих комментариев /* следует использовать

Answer 2

/* My Comment */    is usually used for making a comment block.

/** MyComment */    is usually used for documentation purposes, such as desribing variables and things like that.

Answer 3

Да, вы должны использовать /**, чтобы связать его; не /*. Спасибо

Дополнительная информация здесь