Инструмент аннотации исходного кода [закрывается]
Я ищу инструмент, которым я могу аннотировать исходный код.
У меня есть некоторый сторонний исходный код (JavaScript), я должен понять, и я не хочу изменяться, он (добавьте встроенные комментарии) так, чтобы
- номера строки могут остаться неповрежденными (для связи с другими),
- Я могу постараться не случайно изменять что-то и
- мои аннотации выделяются по сравнению с комментариями авторов.
Обычно я распечатал бы все это каракули на нем, но код является слишком длинным для этого, и я должен совместно использовать его на электронную почту. Я был бы великим, если можно было бы сделать, некоторым нравится этот включая способность создать "ссылки" между так местами в коде, возможно даже визуально со строки или стрелки.
7 ответов
Если вы обычно распечатываете его (если он был короче), почему бы не распечатать его в формате PDF, а затем использовать программу просмотра PDF, которая поддерживает комментарии, например Foxit Reader? :)
Вы определенно можете делать все, что хотите, с LaTeX и его пакетом списков. Но если вы еще не являетесь пользователем LaTeX, вы можете подумать, что это трудный путь.
У вас сложные требования. Я не знаю такого инструмента. Тем не менее в качестве инструмента более общего назначения я могу порекомендовать Yui Doc (загрузить здесь ).
Как насчет использования google wave с ботом syntaxy (http://wave-samples-gallery.appspot.com/about_app?app_id=14008)?
Я бы использовал email для комментирования и pastebin для размещения и выделял @h@ строки со ссылками в тексте письма.
ИЛИ
какой-нибудь инструмент для просмотра кода (например, codestricker или reviewboard)
создайте проект на github и опубликуйте код там, github включает возможности аннотации OOB.
Я бы создал для него гламурный браузер. (Если потратить полдня на его создание, это не будет слишком много).
[edit] Glamour - это набор инструментов для создания браузеров на модели. Модель состоит из различных частей файла (файлов) и комментариев и атрибутов, которые вы хотите добавить. Это позволит вам легко перемещаться по исходному тексту и комментариям, чтобы выбрать только части с определенными атрибутами (или без них). Имеется видео и слайды. Официальная страница, Источник