在舊版語言服務中的註解程式碼

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件。

程式設計語言通常會提供方法來加註或註解的程式碼。 註解是一段文字，提供程式碼的其他資訊，但會忽略在編譯或解譯。

受管理的封裝 (MPF) 架構類別提供支援註解和取消註解選取的文字。

註解樣式

有兩種一般的樣式的註解︰

1. 行註解，其中註解是在同一行。

2. 區塊註解，註解可能包括多行程式碼的位置。

行註解通常有起始字元 （或字元），區塊註解時有開始和結束的字元。 例如，在 C# 中，行註解開頭 / /，以及區塊註解的開頭 / *，並結束*/。

當使用者選取命令註解選取範圍從編輯 -> 進階] 功能表上，此命令路由至CommentSpan方法來源類別。 當使用者選取命令取消註解選取範圍，命令會路由傳送至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;  
        }  
    }  
}  

另請參閱

舊版的語言服務功能
註冊舊版語言服務