2010-05-21 10 views
23

Estoy buscando una herramienta con la que pueda anotar el código fuente.Herramienta de anotación de código fuente

que tienen algo de código fuente de tercera parte (JavaScript) lo necesario para comprender y no quiero cambiarlo (añadir comentarios en línea) para que

  • números de línea pueden permanecer intactos (para la comunicación con los demás),
  • Puedo evitar cambiar accidentalmente algo y
  • mis anotaciones se destacan en comparación con los comentarios de los autores.

Normalmente me gustaría imprimir todo un garabato, pero el código es demasiado largo para eso y tengo que compartirlo por correo electrónico. Sería genial si uno pudiera hacer algo así, incluyendo poder crear "enlaces" entre los lugares en el código, posiblemente incluso visualmente con líneas o flechas.

+3

Una cuestión interesante ... – nickf

Respuesta

14

Si normalmente lo imprime (si fuera más corto), ¿por qué no imprimirlo en un PDF y luego usar un visor de PDF que admita comentarios, como Foxit Reader? :)

+0

+1: ciertamente una mejor respuesta de propósito general que la mía. –

+0

Esto suena como una forma accesible. Estoy pensando en algo similar con anotaciones en un procesador de textos. – RoToRa

+0

Uso Open Office para comentar el código y mantenerlo en este formato para fines de revisión. – Shivam

1

Tiene requisitos difíciles. No sé de tal herramienta. Sin embargo, como una herramienta más general, puedo recomendar Yui Doc (descargue here).

+0

Desafortunadamente no creo generadores documentaion normales me ayudarán mucho. El código que tengo tiene un uso intensivo de funciones anónimas para cierres, funciones de orden superior y currying. – RoToRa

2

Sin duda puede hacer lo que quiera con LaTeX y su paquete de listados. Pero si aún no eres usuario de LaTeX, podrías pensar que es una tarea difícil.

1

Construiría un glamour browser para él. (Si pasa medio día construyendo, no sería demasiado).

[editar] Glamour es un conjunto de herramientas para construir navegadores en un modelo. El modelo aquí consistiría en las diversas partes del archivo (s) y los comentarios y atributos que desea agregar. Esto le permitiría navegar fácilmente a través de la fuente y los comentarios, para seleccionar solo partes con (o sin) ciertos atributos. Hay un video y diapositivas. Official page, Source

+1

¿Qué se supone que es Glamour? He revisado la página web varias veces y simplemente no entiendo ... – RoToRa

2

iniciar un proyecto github y publicar el código allí, github incluye las capacidades de anotación OOB.

+0

La funcionalidad de las anotaciones es realmente buena. Al principio era muy escéptico, pero ahora estoy convencido de que funcionan muy bien. –

+2

¿Podría dar un enlace donde se describa esta característica? No puedo encontrar nada en el sitio de github. – RoToRa

4

Me gustaría utilizar el correo electrónico para comentar y pastebin para alojar y resaltar @[email protected] líneas con enlaces en el texto del correo electrónico.
O
alguna herramienta de código de revisión (como codestricker o reviewboard por ejemplo)

Cuestiones relacionadas