0
Мне нужна документация библиотеки. Однако я не могу решить, какой подход принять. Я думаю, что для меня самое главное, что документация (API doc) является актуальной, всегда и что она очень полезна (например, предоставляет примеры кода и содержит множество описаний). Однако, это проблема, если мой исходный код заполнен doc-тегами? Я пишу JavaScript, если это имеет значение, и, тем не менее, будет выпущена производственная версия.Ввод нагрузок HTML, пример кода и текста в doc-теги?
Я смотрел в ExtJS, и кажется, что они загружают HTML внутри своих исходных файлов. Я думаю, что это упрощает ведение документации в актуальном состоянии и что сложнее забыть документацию о функции. Однако это выглядит так уродливо - я единственный?