2008-09-26 25 views
2

我有幾個模塊包含函數,類和模板,我保存在一個名爲(哈!)'重用'的目錄中。我知道內容合理,所以要找到一個特定的類或代碼不需要太長時間,但它的大小正在緩慢增長,我需要一些明智的方法來存儲它們以便輕鬆搜索&檢索。可重用的代碼/類庫

我該怎麼做?通過區域使用的(網絡,安全性,文本處理,等等)full text search for source code

+0

可能重複的[如何索引並提供可重用代碼?](http://stackoverflow.com/questions/237946/how-do-i-index-and-make-available-reusable-code) – kapa 2012-07-05 16:22:33

+0

@bažmegakapa:同意 - 我甚至沒有意識到這一點,投票結束。 – slashmais 2012-07-05 16:37:23

回答

0

This問題涵蓋了幾乎相同的地面&在它的支持,我會關閉這個問題。

3
  • 源組;:


    一個相關的問題可以在這裏找到最好在目錄以方便瀏覽。

  • 標籤功能將關鍵字添加到源文檔中。使用適當的註釋標記系統(如javadoc)並創建一些可索引的文檔。
  • 搜索通過對您的來源使用某種全文搜索(grep -r,谷歌桌面)。
+0

我已經使用了帶有前綴的分組形式,並且按照您的建議或多或少地進行搜索。我還沒有爲它們編制索引,但標記的想法聽起來似乎合理:一種超級鏈接的文檔,允許我打開/瀏覽模塊? – slashmais 2008-09-26 16:09:15

+0

這實際上取決於您正在編寫的語言。有Sandcastle for C#來創建CHM文件,Java的javadoc創建了一堆HTML。大多數語言都有這種文檔系統。 – 2008-09-26 16:56:01

0

你可以分解目錄中的所有類。

這個問題的語言是什麼?因爲.Net,你可以擁有一個像命名空間一樣分配的DLL。

0
  1. 按功能將函數/類/模板分組到模塊/目錄中。假裝你將它們作爲開源庫發佈;考慮你希望如何組織其他人的代碼。最終,這將是別人的代碼:你,一年或兩年前。
  2. 使用文檔系統。 Doxygen會爲您生成一個方便的HTML代碼瀏覽器。
1

通常,我根據文件的一般用途對文件進行分組。

例: 重用\數據庫 重用\圖形 重用\數學 重用\等等...

然後,您可以子組的組

重用\圖形\ 2D 重用\顯卡\ 3D

HTH

1

取決於系統,但瞬間可重複使用的量能達到一定的閾值我傾向於試圖將它的邏輯塊轉換爲「真實」庫,就像你從第三方(包括文檔等)使用的那樣,並將它們放到相應的庫路徑中,以便它們變得真正可重用。

如果您不介意在某些OSS許可證下將它們提供出去,甚至可以將它們放入CPAN/PyPI/PEAR-等同於您使用的任何環境。這增加了更多的可重用性。

我想重要的部分仍然是你的代碼捆綁到真正的庫。然後,檢索部分應該更容易,因爲大多數是自動的。

0

前段時間曾對此發生過爭論。標準的代碼化對代碼的可讀性和組織性有好處,但是當你只想抓取東西時,另一種方式是使用標籤(比如通過向文件名或其他元數據添加標籤)。標籤在文件夾中的作用很好,因爲您可以快速地挖掘特定或一般的東西,而使用文件夾則需要挖掘樹木以獲取特定的東西。

標籤:O(n)。文件夾:O(n^2)

也許。 :P

0

使用Doxygen/Perldoc/* Pod/*提取的文檔,根據語言(可細分爲函數)和帶標籤的VCS'd目錄進行分級。你必須的可重用模塊/文檔瞬間便攜式容易greppable歸檔到你的工作./