Вопрос на StackOverflow:

Я всегда находил тег remarks в C# очень полезным для предоставления замечаний о реализации класса или метода, а также для передачи информации о теории того, что я реализовывал. Сейчас я перешёл на Java, но не могу найти соответствующий тег JavaDoc для этой цели. Может...

У меня есть класс с двумя методами:

contains() и
containsSame()

Различие между этими методами тонкое, и я хотел бы упомянуть об этом в Javadoc.

Как в Javadoc можно сослаться на метод в том же классе по имени?

В OpenJDK для метода:

public static Double valueOf(double d)

в документации написано:

Возвращает экземпляр Double, представляющий указанное значение типа double. Если новый экземпляр Double не требуется, этот метод следует обычно использовать вместо конструктора Double(double), так...

Как правильно использовать тег @link для ссылок на методы?

Я хочу изменить следующий код:

/**

• Возвращает объект Baz, принадлежащий объекту Bar, который принадлежит объекту Foo,
• который принадлежит данному объекту.
• Удобный метод, эквивалентный getFoo().getBar().getBaz()
• @return baz ...

Я столкнулся с проблемой при добавлении небольшого примера кода в комментариях Javadoc для метода.

Вот фрагмент кода, который я пытаюсь вставить:

/**
 * -- пример: перебор списка объектов Map --
 * 
 * for (int i = 0; i < list.size(); i++) {
 *      Map map = (Map)list.get(i);
 *     ...