Могу ли я просмотреть javadoc для реализации, а не для интерфейса в IntelliJ IDEA? - PullRequest
3 голосов
/ 24 мая 2010

Я использую стороннюю библиотеку в своем проекте Intellij IDEA. Когда у меня есть курсор на имени метода, я могу нажать Ctrl-Q, чтобы получить javadoc в окне «Быстрый поиск документации», однако отображается только сигнатура метода. Это связано с тем, что типом объекта, содержащего метод, является интерфейс без комментариев Javadoc. Реальная реализация объекта имеет комментарии Javadoc. Если я приведу объект к типу реализации, появятся комментарии javadoc. Могу ли я что-то сделать в IntelliJ, чтобы это работало без внесения каких-либо изменений в код?

1 Ответ

1 голос
/ 25 мая 2010

Извините, это не сильно поможет. Но мне интересно:

Зачем кому-то документировать классы реализации, а не интерфейс? Интерфейс документирует контракт, которого обычно должно быть достаточно, и реализующий класс может, конечно, похвастаться, насколько хорошо он реализует контракт, или указывать, почему он его нарушает, но в 90% случаев для реализации достаточно тега {@inheritDoc}. метод, в то время как интерфейс должен определять семантику метода.

Одна из причин, по которой вы делаете это таким образом, - это та, с которой вы только что столкнулись: люди, которые разрабатывают код на основе интерфейсов (и я надеюсь, что все мы), нуждаются в документировании этих интерфейсов. Если мне нужно посмотреть функциональность реализующих классов, зачем вообще работать с интерфейсами?

Конечно, есть исключения, когда реализующие методы должны документироваться (см. Выше), и, конечно, реализации классов и конструкторов всегда должны быть документированы, но API с недокументированными интерфейсами, на мой взгляд, плох API.

...