Добавление изображений в исходный код
Существует ли путь (или редактор), который позволяет мне связывать image/files/http ссылки из исходного файла (*.java, например), вид подобных документ обогащенного текста?
Таким образом, при чтении кода я могу быстро посмотреть на добавленное изображение (увеличивающий комментарии), вместо того, чтобы открыть браузер и т.д.
3 ответа
Javadocs - это HTML, поэтому вы можете просто вставить туда изображения:
/**
* This class does some funky stuff (see diagram).
* <img src="relative/path/to/your/image.png" />
*
*/
public class FunkyClass{
}
Eclipse с удовольствием покажет вам изображения в просмотре javadoc или при наведении курсора на комментарий. Другие IDE могут делать то же самое, а могут и не делать.
Очевидно, вы должны каким-то образом убедиться, что изображения развернуты вместе с javadoc...
Вы можете добавить и
в javadoc ваших классов.
Вероятно, у вас есть инструменты и плагины, позволяющие легко просматривать документацию Javadoc вашего файла.
Хорошим примером смешивания изображений и ссылок в Javadoc является JRootPane
По промышленному стандарту, исходный код почти всегда является только текстовым (будь то кодировка ASCII или unicode). Вы всегда можете нарисовать ASCII-арт ;-)