Kód komentáře ve službě starší verze jazyka

Programovací jazyky obvykle poskytují způsob, jak opatřit poznámky nebo komentovat kód. Komentář je část textu, která poskytuje další informace o kódu, ale je ignorována během kompilace nebo výkladu.

Třídy spravovaného balíčku architektury (MPF) poskytují podporu pro přidávání komentářů a odkomentování vybraného textu.

Styly komentářů

Existují dva obecné styly komentářů:

  1. Komentáře k řádku, kde je komentář na jednom řádku.

  2. Zablokuje komentáře, kde komentář může obsahovat více řádků.

Komentáře k řádkům obvykle mají počáteční znak (nebo znaky), zatímco komentáře bloku mají jak počáteční, tak koncové znaky. Například v jazyce C# začíná řádkový komentář // a komentář bloku začíná /* a končí na */ .

Když uživatel vybere příkaz pro Výběr komentáře z nabídky Upravit > Upřesnit , příkaz se směruje do CommentSpan metody Source třídy. Když uživatel vybere příkaz pro zrušení komentáře výběru, je příkaz směrován do UncommentSpan metody.

Komentáře k kódu podpory

Je možné, že vaše jazyková služba podporuje komentáře kódu prostřednictvím EnableCommenting pojmenovaného parametru ProvideLanguageServiceAttribute . Tím se nastaví EnableCommenting vlastnost LanguagePreferences třídy. Další informace o nastavení funkcí jazykové služby najdete v tématu Registrace starší verze jazykové služby.

Musíte také přepsat GetCommentFormat metodu pro vrácení CommentInfo struktury se znaky komentáře pro váš jazyk. Znaky komentáře řádku ve stylu jazyka C# jsou výchozí.

Příklad

Zde je příklad implementace GetCommentFormat metody.

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;
        }
    }
}

Viz také