給VC增加注釋/反注釋的功能
??????????????? ――楊科? 注:本文可隨意轉載, 但請保留我的署名(CopyLeft)
用過VB，PowerBuilder的朋友一定知道在它們的工具條上有兩個按鈕，用來完成對選中的代碼進行注釋或反注釋，而在VC中如果要注釋一段選中的代碼，除了在要注釋的代碼中添加/* 和 */外，就是對每一行都使用單行注釋//。其實在VC中提供了編寫插件的功能，VC將開發環境中的各種對象以COM接口的形式暴露出來，而且提供的插件應用程序向導可以完成大部分的框架代碼，所以我們只需要添加我們想要的功能就可以了。所以我們可以利用這些COM接口來對VC的開發環境進行操作，這樣我們就可以完成對選中的代碼的注釋和反注釋功能。
下面具體描述以下開發這個插件的過程：
首先創建一個新工程，類型選擇DevStudio Add-in Widzard，填寫工程名稱后，單擊OK繼續。在接下來的頁面中選中Provides a toolbar，這會使我們創建的插件具有一個工具條，不需要選中Responds to Developer Studio events，因為我們不需要對開發環境中的事件作出響應，在上面的兩個文本框中，可以隨便輸入一些你對這個插件的描述及功能介紹，單擊Finish完成向導。
對了，首先聲明以下，在VC中每一個Add-in都是一個COM組件，在Add-in的向導中生成的程序是用MFC和ATL共同實現的，所以在生成的原代碼中你會看到兩個分別叫做theApp和_Module的全局變量。另外向導為我們生成了一個成為ICommands的接口，我們必須在這個接口添加適當的方法來完成我們需要的功能。
讓我們看一下AppWidzard為我們生成了哪些類，首先我們會看到一個CCommands的類，而且其中實現了我們在上面提到的ICommands接口。一個稱為CDSAddIn的類，這個類中實現兩個方法OnConnection(), OnDisconnection(), 這兩個方法我們不會直接在程序中調用，而是由VC集成環境調用的，當VC啟動時它會首先查詢關于Add-ins的注冊信息，然后調用相應組件的OnConnection()方法，所以在這個方法中我們應該把我們要實現的命令添加到VC的繼承環境中，當這個插件被卸載或VC關閉時，VC會調用OnDisconnection（）方法，在這里我們應該釋放我們在OnConnection（）中分配的資源。
剩下的就是應用程序類了，另外還有一些必須的全局函數DllGetClassObject, DllCanUnloadNow, DllRegisterServer和DllUnregisterServer是COM組件的幾個通用實現，可以查閱關于COM的書籍來了解這些知識。
AppWidzard生成的代碼中在ICommands接口中實現了一個與應用程序同名的方法，通常這個方法名稱并不是我們需要的，所以下面就開始來改寫這個方法，把它改成CommentCode。雙擊ICommands接口中的與你應用程序同名的方法，VC會打開一個與你的應用程序同名的一個擴展名是odl的文件，找到一行叫做HRESULT YourAppCommandMethod()并把YourAppCommandMethod改成CommentCode()，然后打開Commands.cpp和Commands.h把其中的YourAppCommandMethod都改成CommentCode()。
現在我們修改DSAddIn.cpp，找到OnConnection方法，直接找到下面這斷代碼：
LPCTSTR szCommand = _T("YourAppCommand");
VARIANT_BOOL bRet;
CString strCmdString;
strCmdString.LoadString(IDS_CMD_STRING);
strCmdString = szCommand + strCmdString;
CComBSTR bszCmdString(strCmdString);
CComBSTR bszMethod(_T("YourAppCommandMethod"));
CComBSTR bszCmdName(szCommand);
VERIFY_OK(pApplication->AddCommand(bszCmdString, bszMethod, 0, m_dwCookie, &bRet));
并把它改成下面的樣子：
LPCTSTR szCommand = _T("CommentCode");
VARIANT_BOOL bRet;
CString strCmdString;
strCmdString.LoadString(IDS_CMD_STRING);
strCmdString = szCommand + strCmdString;
CComBSTR bszCmdString(strCmdString);
CComBSTR bszMethod(_T("CommentCode"));
CComBSTR bszCmdName(szCommand);
VERIFY_OK(pApplication->AddCommand(bszCmdString, bszMethod, 0, m_dwCookie, &bRet));
由于上面的代碼涉及到了字符串資源，所以我們再來看看上面提到的IDS_CMD_STRING的內容，打開這個字符串資源改成下面的形式：
Comment Code Comment the selected code Comment the selected code
現在我們可以編譯這個應用程序，應該不會出現錯誤，單擊運行會彈出一個對話框要你指定一個宿主應用程序來調用這個DLL, 因為我們是為VC開發插件應用，所以找到你VC的可執行文件目錄并選中msdev.exe。當另一個VC啟動后，選擇Tools¦Customize...，叢屬性頁種選擇Add-ins and Macro Files標簽，單擊Browse按鈕，選擇你剛生成的DLL文件，這時旁邊的列表框，會出現你編寫的插件的名字，單擊Close關閉對話框，這是在工具條的下面會出現一個小工具條，將鼠標移動工具條的按鈕上面，會出現Comment the selected code的代碼提示, 單擊按鈕會彈出一個對話框，這是AppWidzard對這個命令的缺省實現。
下面我們該實現我們的具體功能的代碼了。由于VC把它集成環境中對象通過COM接口暴露出來，所以我們就利用這些對象來實現注釋代碼的功能。這里有兩個問題：1、我們怎么能知道VC中當前打開的文檔是否是源代碼而不是圖形或對話框，2、我們怎么才能知道當前源代碼文檔中的被選擇的文本。下面我通過實際的代碼來解釋這兩個問題。
1、查找當前打開的源代碼編輯其中的文檔并查找當前選中的文本。這里我寫了一個函數因為在實現反注釋的時候我們還需要完成相同的功能。請參閱代碼中的注釋（注意相應接口指針的釋放）：
HRESULT CCommands::GetTextSelection(IApplication *pApplication, ITextSelection** pTextSelection)
{
IDispatch* pDispatch;
//通過有集成環境傳進來的應用程序對象查找當前處于活動狀態的文檔對象，注意返回的是一個IDispatch接口指針。
HRESULT hr = pApplication->get_ActiveDocument(&pDispatch);
//此處應注意即使get_ActiveDocument()函數成功返回pDispatch指針仍有可能為空（即VC中沒有文檔打開)，所以此處要判 //斷pDispatch是否為空
if (SUCCEEDED(hr) && pDispatch != NULL)
{
//取得IGenericDocument接口的指針，我們可以通過該接口指針來查詢當前的活動文檔是否是文本文檔。
IGenericDocument* pDocument；
hr = pDispatch->QueryInterface(IID_IGenericDocument, (void**)&pDocument);
if (FAILED(hr))
{
pDispatch->Release();
return E_NOINTERFACE;
}
pDispatch->Release();
//在此處查詢ITextDocument接口，如果能成功返回，就說明當前文檔是文本文檔。
ITextDocument* pTextDocument;
hr = pDocument->QueryInterface(IID_ITextDocument, (void**)&pTextDocument);
if (FAILED(hr))
{
pDocument->Release();
return E_NOINTERFACE;
}
pDocument->Release();
//現在我們有了當前的活動的文本文檔，我們就可以通過get_Selection函數來獲得當前選中的文本，這里要求的還是 //一個IDispatch接口的指針
hr = pTextDocument->get_Selection(&pDispatch);
if (FAILED(hr))
{
pTextDocument->Release();
return E_NOINTERFACE;
}
pTextDocument->Release();
//通過QueryInterface（）方法取回ITextSelection的接口指針。
hr = pDispatch->QueryInterface(IID_ITextSelection, (void**)pTextSelection);
if (FAILED(hr))
{
pDispatch->Release();
return E_NOINTERFACE;
}
pDispatch->Release();
}
else
return E_NOINTERFACE;
return S_OK;
}
上面的方法已經解決了這兩個問題，接下來的任務就是實現注釋被選中的代碼。請參閱下面的代碼（省略了錯誤處理的部分代碼）
HRESULT CCommands::CommentSelectedCode(ITextSelection *pTextSelection)
{
long lTopLine = -1;
long lBottomLine = -1;
long lCurLine;
long lCurColumn;
//取得被選中文本的最上面一行的行號
HRESULT hr = pTextSelection->get_TopLine(&lTopLine);
//取得被選中文本的最下面一行的行號
hr = pTextSelection->get_BottomLine(&lBottomLine);
long iLine;
CString s;
_variant_t v((long)dsMove);
//循環，針對選中的每一行，在前面加上VC的單行注釋//
for(iLine = lTopLine; iLine <= lBottomLine; iLine++)
{
hr = pTextSelection->MoveTo(iLine, 1, v);
if (SUCCEEDED(hr))
{
pTextSelection->SelectLine();
BSTR bstrLineText;
hr = pTextSelection->get_Text(&bstrLineText);
if (SUCCEEDED(hr))
{
s = bstrLineText;
s = _T("http://") + s;
pTextSelection->put_Text(s.AllocSysString());
}
}
}
return S_OK;
}
上面的代碼就完成了對選中的代碼的注釋問題，下面添加對選中的代碼的反注釋功能，其中的代碼大體相同，這里主要講解如何間命令添加到VC的開發環境中去。
在ClassView中右鍵單擊ICommands接口，選擇Add method...，添加UncommentCode方法，參照上面的代碼實現相應的功能。
打開CDSAddIn類的OnConnection方法，在添加CommentCode方法的下面添加下面的代碼：
szCommand = _T("UncommentCode");
strCmdString.LoadString(IDS_CMD_UNCOMMENT);
strCmdString = szCommand + strCmdString;
bszCmdString = strCmdString;
bszMethod = _T("UncommentCode");
CComBSTR bszCmdUncommentName = szCommand;
VERIFY_OK(pApplication->AddCommand(bszCmdString, bszMethod, 1, m_dwCookie, &bRet));
然后在OnConnection()方法的下面的代碼中
if (bFirstTime == VARIANT_TRUE)
{
VERIFY_OK(pApplication->AddCommandBarButton(dsGlyph, bszCmdName, m_dwCookie));
}
添加一行，如下面的代碼
if (bFirstTime == VARIANT_TRUE)
{
VERIFY_OK(pApplication->AddCommandBarButton(dsGlyph, bszCmdName, m_dwCookie));
VERIFY_OK(pApplication->AddCommandBarButton(dsGlyph, bszCmdUncommentName, m_dwCookie));
}
在上面的pApplication->AddCommand()調用中，第三個參數1，指定了該命令所對應的圖像在位圖資源中的位置。
適當的修正工程的資源，完成的應用程序應該可以完成VB,PowerBuilder中的代碼的注釋和反注釋功能。
另外，由于VC中的插件是通過COM技術實現的，所以能支持COM規范的語言都可以用來編寫VC插件。
本文來自CSDN博客，轉載請標明出處：http://blog.csdn.net/panbinfeng/archive/2006/04/17/666816.aspx