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