Комментарии Javadoc или комментарии блоков?

Когда уместно использовать блочный комментарий в начале методов, а когда уместно использовать комментарий в стиле javadoc?

В разделе «Комментарии» Руководства по стилю Java я обнаружил следующее:

Программы Java могут иметь два типа и когда уместно использовать комментарий в стиле javadoc? В разделе «Комментарии» руководства по стилю Java я обнаружил ...

Когда уместно использовать блочный комментарий в начале методов, а когда уместно использовать комментарий в стиле javadoc?

В разделе «Комментарии» Руководства по стилю Java я обнаружил следующее:

Программы Java могут иметь два типа и когда уместно использовать комментарий в стиле javadoc? В разделе «Комментарии» руководства по стилю Java я обнаружил ...

Когда уместно использовать блочный комментарий в начале методов, а когда уместно использовать комментарий в стиле javadoc?

В разделе «Комментарии» Руководства по стилю Java я обнаружил следующее:

Программы Java могут иметь два типа комментарии: комментарии к реализации и комментарии к документации. Реализация комментарии - это те, которые можно найти в C ++, которые разделены /*...*/ и //. Комментарии к документации (известные как "doc комментарии ") предназначены только для Java и разделены /**...*/ . Комментарии к документу можно извлечь в файлы HTML с помощью инструмент javadoc.

Комментарии к реализации предназначены для комментирование кода или комментарии о конкретной реализации. Комментарии к документам предназначены для описания спецификация кода, из перспектива без реализации. быть читают разработчики, которые могут не обязательно иметь исходный код на hand.

So, another way to phrase my question would be: When do methods deserve a specification of the code, from an implementation-free perspective (Javadoc) instead of a comment about a particular implementation, and vice versa? Would an interface get javadoc comments, while the implementations get block comments?

edit: I think I am not conveying my question correctly, based on the answers thus far.

Here's an example of what I want to know.

/**
 * Javadoc comment here about general implementation?
 */
/*
 * Should I now have a separate block comment for my specific implementation?
 */
public void foo()
{
...
}

The two different comment styles convey two different types of information. Are there cases when methods should have BOTH a leading javadoc comment, and a leading block comment?

The inspiration for even asking is that Eclipse auto-generated this for me just now:

/*
 * (non-Javadoc)
 * @see my.package#process()
 */

And I figured there is some sort of styling going on here that isn't declared specifically in the comment specifications I link to above.

34
задан Tony Stark 31 August 2010 в 09:24
поделиться

1 ответ

По моему мнению, комментарии Javadoc — это комментарии, которые вы пишете людям, использующим ваш код и вызывающим ваши методы.

Комментарии Javadoc больше сосредоточены на параметрах методов, то есть на том, что ваш метод вернет, в зависимости от параметров, которые вы задали своим методам.

Блочные комментарии — это внутренние комментарии, комментарии, которые вы пишете для людей, поддерживающих ваш код.

Блочные комментарии важны для понимания того, как работает код, почему он работает и какие операции используются для выполнения фактической работы.

12
ответ дан 27 November 2019 в 16:25
поделиться
Другие вопросы по тегам:

Похожие вопросы: