如何處理尚未記錄的現有項目？

我只從事過從頭開始的項目，但現在我開始了一個沒有文檔和指導的預先存在的項目。所有參與該項目的人都離開了，我的客戶希望我開始工作。常識是從主頁開始，隨着學習什麼是什麼以及它在哪裏。如何處理尚未記錄的現有項目？

該網站建立在Codeigniter（PHP）上，擁有超過500頁的頁面，最多有900-1100行代碼，以及多個自定義選項。是否有任何有效且非耗時的方法開始？任何可能有幫助的工具？

2011-10-27 Rick Rhodes

號如果將有，爲什麼文件的一個項目呢？ – str

開始總是耗時。我會從應用程序目錄下的控制器和視圖開始 – galchen

檢查某人的代碼總是很困難。沒有逃脫，你必須研究它。一些建議：1.像你說的，你最好的選擇是從主頁開始，逐步進入項目的內部。 2.使用一個好的IDE，以便您可以輕鬆瀏覽源文件，並從類，聲明和實現中跳轉（除非它最初製作的IDE具有所有這些）3.除非確定，否則不要急於更改任何內容你會得到整個圖像，因爲那樣你永遠不知道它什麼時候會回覆你。 4. SVN/GIT你的項目在做任何事之前。祝你好運。 –

我一直在這種情況一次或兩次。我不認爲有任何工具可以真正幫助您，因爲文檔通常是程序員和代碼之間的粘合劑，但我沒有真正尋找它們。

我的確有兩個評論。首先，這會花費您很多時間。 A lot。基本上，你是逆向工程。在給出估算時（如果需要的話）考慮到這一點。

其次，你最好的選擇是隨時記錄事情。你遇到的每一個功能，記錄你認爲應該做的事。這樣，您可以回顧一下您已經檢查過的功能，而無需再次檢查它們。如果您不知道函數的內部功能是什麼，請暫時保留並轉到其他函數或方法。最後，如果沒有任何文檔，你所能做的就是在代碼中執行程序，並在程序運行時（假設它運行），所以你可以猜測它應該是什麼做。記錄較小的功能，根據大的功能/類別工作。存儲你遇到的任何筆記。在可能的情況下進行清理，但只有在您對清理的部分應該做什麼的時候纔有固體感。這可能需要一些時間。

不確定這真的有幫助，但這是一個糟糕的情況，我只能希望你的代碼比文檔更好。如果不是那麼好，那麼你還必須考慮重寫零件的時間。

祝你好運。

來源

2011-10-27 17:29:01

使用對於獲得可讀/可瀏覽的項目結構大綱非常有用，它在標準安裝中支持PHP。它會生成一個HTML文檔，其中包含程序中各種依賴關係之間的超鏈接。

運行它很簡單：

cd <project-top-level-directory> 
doxygen -g 
doxygen Doxyfile

來源

2011-10-27 17:42:33

如何處理尚未記錄的現有項目？

回答

相關問題