Công cụ chú thích mã nguồn

Question

Tôi đang tìm một công cụ mà tôi có thể chú thích mã nguồn.

Tôi có một số mã nguồn bên thứ 3 (JavaScript) Tôi cần phải hiểu và tôi không muốn thay đổi nó (thêm ý kiến ​​inline) để

• số dòng có thể ở lại nguyên vẹn (để giao tiếp với người khác),
• Tôi có thể tránh vô tình thay đổi thứ gì đó và
• chú thích của tôi nổi bật so với nhận xét của tác giả.

Thông thường tôi sẽ in toàn bộ nội dung đó ra một đoạn viết nguệch ngoạc trên đó, nhưng mã quá dài và tôi cần chia sẻ nó cho mỗi email. Tôi sẽ là tuyệt vời nếu người ta có thể làm một số như thế bao gồm cả việc có thể tạo ra "liên kết" giữa những nơi trong mã, thậm chí có thể trực quan với một dòng hoặc mũi tên.

Answer 1

Nếu bạn thường in nó (nếu ngắn hơn), tại sao không in ra PDF và sau đó sử dụng trình xem PDF hỗ trợ nhận xét, như Foxit Reader? :)

Answer 2

Bạn có những yêu cầu khó khăn. Tôi không biết về công cụ đó. Tuy nhiên, như một công cụ đa năng hơn, tôi có thể giới thiệu Yui Doc (tải xuống here).

Answer 3

Bạn chắc chắn có thể làm những gì bạn muốn với LaTeX và gói danh sách của nó. Nhưng nếu bạn chưa phải là một người dùng LaTeX, bạn có thể nghĩ rằng đó là một con đường khó đi.

Answer 4

Tôi muốn tạo một glamour browser cho nó. (Nếu dành nửa ngày xây dựng nó sẽ không quá nhiều).

[biên tập] Glamour là bộ công cụ để xây dựng trình duyệt trên mô hình. Mô hình ở đây sẽ bao gồm các phần khác nhau của (các) tệp và các nhận xét và thuộc tính bạn muốn thêm vào. Điều này sẽ cho phép bạn dễ dàng điều hướng thông qua nguồn và nhận xét, để chỉ chọn các phần có (hoặc không có) các thuộc tính nhất định. Có video và trang trình bày. Official page, Source

Answer 5

bắt đầu dự án github và đăng mã ở đó, github bao gồm khả năng chú thích OOB.

Answer 6

Làm cách nào để sử dụng wave google với cú pháp (http://wave-samples-gallery.appspot.com/about_app?app_id=14008) bot?

Answer 7

Tôi sẽ sử dụng email để nhận xét và pastebin để lưu trữ và đánh dấu @h@ dòng có liên kết trong văn bản email.
HOẶC
một số công cụ mã-xét (như codestricker hoặc reviewboard ví dụ)