2010-05-21 20 views
23

Szukam narzędzia, za pomocą którego mogę opisać kod źródłowy.Narzędzie do przypisywania kodu źródłowego

Mam kod źródłowy 3-ty partia (JavaScript) Muszę zrozumieć i nie chcą go zmienić (dodać komentarze inline), tak że

  • numery linii może pozostać w stanie nienaruszonym (do komunikacji z innymi),
  • Mogę uniknąć przypadkowej zmiany czegoś i
  • moje adnotacje wyróżniają się w porównaniu do komentarzy autorów.

Normalnie wydrukowałbym całą całość, ale kod jest za długi i muszę go udostępnić na e-mail. Byłbym świetny, gdyby ktoś mógł zrobić coś takiego, włączając w to możliwość tworzenia "połączeń" między takimi miejscami w kodzie, ewentualnie nawet wizualnie za pomocą linii lub strzał.

+3

ciekawe pytanie ... – nickf

Odpowiedz

14

Jeśli zwykle byś go wydrukował (gdyby był krótszy), czemu by nie wydrukować go do pliku PDF, a następnie użyć przeglądarki PDF obsługującej komentarze, takie jak Foxit Reader? :)

+0

+1: z pewnością lepsza odpowiedź ogólnego przeznaczenia niż moja. –

+0

To brzmi jak przystępny sposób. Myślę o czymś podobnym z adnotacjami w edytorze tekstu. – RoToRa

+0

Korzystam z Open Office, aby skomentować kod i zachować go w tym formacie do celów recenzowania. – Shivam

1

Masz trudne wymagania. Nie znam takiego narzędzia. Niemniej jednak jako narzędzie o bardziej ogólnym celu mogę polecić Yui Doc (pobierz here).

+0

Niestety nie sądzę normalne generatory dokumentowania zgrzewów pomoże mi dużo. Kod, który mam, ma intensywne wykorzystanie anonimowych funkcji dla zamknięć, funkcji wyższych rzędów i curry. – RoToRa

2

Z pewnością możesz zrobić, co chcesz, dzięki LaTeX i pakietowi aukcji. Ale jeśli nie jesteś już użytkownikiem LaTeXa, możesz pomyśleć, że jest to trudna droga.

1

Zbuduję dla niego glamour browser. (Jeśli wydasz pół dnia budowy, to nie będzie za dużo).

[edycja] Glamour to zestaw narzędzi do tworzenia przeglądarek na modelu. Model składałby się z różnych części pliku (ów) oraz komentarzy i atrybutów, które chciałbyś dodać. Umożliwi to łatwą nawigację po źródle i komentarzach, aby wybrać tylko części z (lub bez) niektórych atrybutów. Jest video i slajdy. Official page, Source

+1

Co to jest Glamour? Kilka razy przeszukałem stronę internetową i po prostu nie rozumiem ... – RoToRa

2

Rozpocznij projekt github i umieść tam kod, github zawiera adnotacje umiejętności OOB.

+0

Funkcje adnotacji są naprawdę dobre. Na początku byłem bardzo sceptyczny, ale teraz jestem przekonany, że działają świetnie. –

+2

Czy możesz podać link, w którym opisano tę funkcję? Nie mogę znaleźć niczego na stronie github. – RoToRa

Powiązane problemy