註解的程式碼 (受管理的封裝架構)
程式語言通常會提供一種方法來加註或註解的程式碼。 註解是一段文字所提供的程式碼的其他資訊,但在編譯或解譯期間會被忽略。
受管理的套件的架構 (MPF) 類別會提供註解和 uncommenting 的選取文字中的支援。
註解樣式
有兩種一般註解樣式:
內嵌註解,註解是在同一行的位置。
區塊註解,註解可能包含多行的位置。
內嵌註解通常會有一個開始字元 (或字元),區塊註解時有開始和結束的字元。 比方說,在 C# 行註解開頭 / /,以及區塊註解開頭為 / *,並結束 * /。
當使用者選取命令註解選取範圍 的 編輯 -> 進階 ] 功能表中,命令會路由傳送到CommentSpan上的方法Source類別。 當使用者選取命令取消註解選取項目,命令會路由至UncommentSpan方法。
支援的程式碼註解
您可以讓您語言服務支援的程式碼意見的EnableCommenting的參數名稱ProvideLanguageServiceAttribute 。 這會將EnableCommenting屬性的LanguagePreferences類別。 如需有關如何設定語言 servicce 功能的詳細資訊,請參閱正在註冊語言服務 (管理的套件架構))。
您也必須覆寫GetCommentFormat方法來傳回CommentInfo結構,與您的語言的註解字元。 C#-樣式行註解字元是預設值。
範例
以下是項目的實作範例GetCommentFormat方法。
using Microsoft.VisualStudio.Package;
namespace MyLanguagePackage
{
class MySource : Source
{
public override CommentInfo GetCommentFormat() {
CommentInfo info = new CommentInfo();
info.LineStart = "//";
info.BlockStart = "/*";
info.BlockEnd = "*/";
info.UseLineComments = true;
return info;
}
}
}