Java conventions, комментирование

Мне непонятен этот пункт:

Block comments can start with /*-, which is recognized by indent(1) as the beginning of a block comment that should not reformatted. Example:

/*
 * Here is a block comment with some very special
 * formatting that I want indent(1) to ignore.
 *
 * one
 *    two
 *       three
 */

Note: If you don’t use indent(1), you don’t have to use /*- in your code or make any other concessions to the possibility that someone else might run indent(1) on your code.

Тут говорится о том, что комментарий, который не должен переформатироваться автоматически, должен начинаться с /*, но так все комментарии и начинаются, которые не являются необходимыми для документирования.

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


Ответы (1 шт):

Автор решения: alex9127

Комментарии бывают двух разных типов:

// однострочный комментарий

и

/*
многострочный
комментарий
*/

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

Как сделать так чтобы комментарий не исправлялся, я не знаю. Возможно даже нельзя это сделать.

→ Ссылка