Я использую Eclipse и мне интересно, есть ли плагин для комментариев вне кода. Под этим я подразумеваю комментарии, которые на самом деле не записываются в исходные файлы, но все еще могут просматриваться в среде IDE, предпочтительно комментарии, которые можно назначать отдельным блокам кода, аналогично комментариям, которые вы можете создавать в типичных текстовый процессор:
Мне нужна эта функция, потому что я сейчас создаю программу, которая использует действительно громоздкий сторонний API, и хотя я знаю, что каждый блок кода делает это во время его написания, но это не гарантирует, что я узнаю его через несколько месяцев или что любой, кто решит присоединиться ко мне в моем проекте, будет знать, что из этого делает.
Я мог бы предварять каждый блок кода абзацем комментариев, но для меня это не идеально, это увеличило бы число строк кода более чем в два раза и ухудшило бы читаемость. Я думаю, что этот подход хорош при отправке API, потому что пользователи обычно не пытаются прочитать источник, и когда вам нужно увидеть описание за вызовом функции, он обычно ограничивается этим единственным вызовом функции. Принимая во внимание, что при работе с приложением удобочитаемость обязательна.
Если таких плагинов Eclipse не существует, знает ли кто-нибудь IDE, которая предоставляет такую функцию?