自動文檔 - 創建快速解析器的最佳方法

我有一個最終用戶需要編輯的大腳本，因此它需要多餘的註釋。我用一個佈局類似這樣自動文檔 - 創建快速解析器的最佳方法

//******************** 
// 
// FileName 
// This script contains: 
// - Function X - does something 
// - Function Y - does something else 
// 
//******************** 

//******************** 
// Function X 
// does something (<< I'd only like to enter this part once) 
//******************** 
// Code here... 

//******************** 
// Function Y 
// does something else 
//******************** 
// Code here...

我的文件，我想創建一個簡單的解析器，做的函數摘要的複製/粘貼到文件頭。我知道有幾種工具可以幫助實現這一點，比如ANTLR甚至RegEx，但是最好的方法是什麼？

來源

2009-12-01 Daniel Harvey

是否複製/粘貼了您的內容？我不明白你想要完成什麼。你想從頁眉複製到功能還是什麼？你也應該粘貼一些實際的腳本，以便更容易地告訴匹配什麼和在哪裏。 – 2009-12-01 22:45:39

我試圖澄清OP中的一點。我認爲具體的代碼會混淆這個問題，因爲情況是通用的。 – 2009-12-01 23:07:07

鑑於你提到的兩個選項，ANTLR和正則表達式，我會建議ANTLR。從長遠來看，ANTLR將更加靈活，我相信你應該能夠更有效地使用它（它以語法爲基礎進行解析）。正則表達式方法將被限制爲常規語言，除非您添加一些自定義邏輯和什麼。

作爲一個例子，我懷疑你會很難用正則表達式來區分塊內部和外部塊之間的註釋。 CFG應該能夠做出這樣的區分就好了。然後再次，如果您對源代碼有控制權，您可以就什麼類型的評論出現在哪些地方草擬一些規範...

來源

2009-12-02 03:43:22

自動文檔 - 創建快速解析器的最佳方法

回答

相關問題