2010-05-21 120 views
23

我正在尋找一個可以註釋源代碼的工具。源代碼註釋工具

我有一些第三方的源代碼(JavaScript的)我需要理解,我不想改變它(添加內部註釋),這樣

  • 行號可以保持不變(與他人溝通),
  • 我可以避免意外更改的東西和
  • 我的註釋比作者的評論更加突出。

通常情況下,我會將所有東西打印出來,但代碼太長,我需要通過電子郵件分享它。如果能夠做到這一點,包括能夠在代碼中的這些位置之間創建「鏈接」,甚至可能在視覺上用線條或箭頭,我都會很棒。

+3

一個有趣的問題... – nickf 2010-05-24 14:10:10

回答

14

如果您通常會打印它(如果它較短),爲什麼不將它打印到PDF然後使用支持註釋的PDF查看器,如福昕閱讀器? :)

+0

+1:肯定是比我更好的通用答案。 – 2010-05-21 08:39:52

+0

這聽起來像一個平易近人的方式。我在文字處理器中考慮與註釋類似的東西。 – RoToRa 2010-05-21 08:46:09

+0

我使用Open Office來評論代碼並將其保留爲這種格式用於審閱目的。 – Shivam 2010-05-26 18:25:33

1

您有困難的要求。我不知道這樣的工具。儘管如此,作爲一個更通用的工具,我可以推薦Yui Doc(下載here)。

+0

不幸的是,我不認爲正常的文件建立發電機將幫助我很多。我所使用的代碼大量使用了匿名函數來實現閉包,高階函數和currying。 – RoToRa 2010-05-21 08:45:01

2

你當然可以做你想要的LaTeX和它的列表包。但是如果你還不是LaTeX的用戶,你可能會認爲這是一個艱難的路要走。

1

我會爲它建立一個glamour browser。 (如果花費半天建設它不會太多)。

Glamour是一個在模型上構建瀏覽器的工具包。這裏的模型將包含文件的各個部分以及您想要添加的註釋和屬性。這將允許您輕鬆瀏覽源代碼和註釋,以僅選擇具有(或不具有)特定屬性的部分。有一個video和幻燈片。 Official page,Source

+1

什麼是魅力應該是?我瀏覽過幾次網頁,只是不明白... – RoToRa 2010-05-29 11:35:15

2

啓動一個github項目並在那裏發佈代碼,github包含註釋能力OOB。

+0

註釋功能非常好。我一開始非常懷疑,但現在我確信他們工作得很好。 – 2010-05-30 20:05:01

+2

你可以給一個鏈接描述這個功能嗎?我似乎無法在github網站上找到任何東西。 – RoToRa 2010-05-31 07:50:36