Ferramenta de anotação do código-fonte [fechada]

Estou à procura de uma ferramenta com a qual possa anotar o código-fonte.

Eu tenho algum código fonte de terceiros (JavaScript) eu preciso entender e eu não quero alterá-lo (adicionar comentários inline) de modo que

  • os números de linha podem permanecer intactos (para comunicação com outros),
    • Posso evitar mudar algo acidentalmente e ...
  • As minhas anotações destacam-se em comparação com os comentários dos autores.
Normalmente, imprimia tudo num rabisco. nele, mas o código é muito longo para isso e eu preciso compartilhá-lo por e-mail. Eu seria ótimo se alguém pudesse fazer algo assim, Incluindo ser capaz de criar "links" entre Assim lugares no código, possivelmente até visualmente com uma linha ou flechas.

Author: durron597, 2010-05-21
Source

7 answers

Se você normalmente imprimi-lo (se fosse mais curto), por que não imprimi-lo em um PDF e, em seguida, usar um visualizador de PDF que suporta comentários, como o Foxit Reader? :)

 14
Author: OregonGhost, 2010-05-21 08:38:30

Eu usaria o e-mail para comentar e pastebin para hospedar e realçar as linhas @h@ com ligações no texto do E-mail.
Ou
alguma ferramenta de revisão de código (como codeestricker ou reviewboard por exemplo)

 4
Author: , 2010-05-30 11:32:14

Podes certamente fazer o que quiseres com o LaTeX e o seu pacote de listagens. Mas se você não é já um usuário de látex você pode pensar que uma maneira difícil de ir.

 2
Author: High Performance Mark, 2010-05-21 08:39:11

Iniciar um projecto github e publicar o código lá, o github inclui capacidades de anotação OOB.

 2
Author: Jason, 2010-05-29 14:28:15

Tem necessidades difíceis. Não conheço essa ferramenta. No entanto, como uma ferramenta de propósito mais geral, eu posso recomendar Yui Doc (download aqui ).

 1
Author: ivo, 2010-05-21 08:35:37
Eu construiria um navegador de glamour para ele. (Se passar Meio dia construindo não seria muito).

[editar] Glamour é um kit de ferramentas para construir navegadores em um modelo. O modelo consistiria aqui das várias partes do(S) arquivo (s) e os comentários e atributos que você gostaria de adicionar. Isso lhe permitiria navegar facilmente através da fonte e comentários, para selecionar apenas partes com (ou sem) certos atributos. Há um vídeo e slides. Oficial página, Origem

 1
Author: Stephan Eggermont, 2010-05-30 10:39:46
 0
Author: Maciek Sawicki, 2010-05-30 10:53:10