Инструмент аннотации исходного кода

Я ищу инструмент, с помощью которого я могу комментировать исходный код.

У меня есть сторонний исходный код (JavaScript). Мне нужно понять, и я не хочу его менять (добавьте встроенные комментарии), чтобы

  • номера строк могут оставаться неизменными (для общения с другими),
  • Я могу избежать случайного изменения чего-либо и
  • мои аннотации выделяются по сравнению с комментариями авторов.

Обычно я печатал все это с помощью каракули, но код слишком длинный для этого, и мне нужно поделиться им по электронной почте. Мне было бы здорово, если бы кто-то мог это сделать, включая возможность создавать "ссылки" между такими местами в коде, возможно даже визуально с линиями или стрелками.

Ответы

Ответ 1

Если вы обычно печатаете его (если оно короче), почему бы не распечатать его в PDF файле, а затем использовать средство просмотра PDF, которое поддерживает комментарии, такие как Foxit Reader?:)

Ответ 2

Я бы использовал электронную почту для комментариев и pastebin для размещения и выделения строк @[email protected] со ссылками в тексте электронной почты.
> ИЛИ
некоторый инструмент проверки кода (например codestricker или reviewboard например)

Ответ 3

Вы можете, конечно, сделать то, что хотите, с LaTeX и его пакетом листингов. Но если вы еще не являетесь пользователем LaTeX, вы можете подумать, что это трудно.

Ответ 4

запустите проект github и опубликуйте там код, github включает возможности аннотации OOB.

Ответ 5

У вас трудные требования. Я не знаю такого инструмента. Тем не менее, как инструмент более общего назначения, я могу порекомендовать Yui Doc (скачать здесь).

Ответ 6

Я построил бы гламурный браузер. (Если потратить полдня на строительство, это будет не слишком).

[править] Glamour - это инструментарий для создания браузеров на модели. Модель будет состоять из различных частей файла (ов) и комментариев и атрибутов, которые вы хотите добавить. Это позволит вам легко перемещаться по источнику и комментариям, чтобы выбрать только части с (или без) определенных атрибутов. Существует видео и слайды. Официальная страница, Source