Source.CommentSpan(TextSpan) Metoda

Definice

Zakomentovat zadaný rozsah zdroje.

public:
 virtual Microsoft::VisualStudio::TextManager::Interop::TextSpan CommentSpan(Microsoft::VisualStudio::TextManager::Interop::TextSpan span);
public:
 virtual Microsoft::VisualStudio::TextManager::Interop::TextSpan CommentSpan(Microsoft::VisualStudio::TextManager::Interop::TextSpan span);
 virtual Microsoft::VisualStudio::TextManager::Interop::TextSpan CommentSpan(Microsoft::VisualStudio::TextManager::Interop::TextSpan span);
public virtual Microsoft.VisualStudio.TextManager.Interop.TextSpan CommentSpan (Microsoft.VisualStudio.TextManager.Interop.TextSpan span);
abstract member CommentSpan : Microsoft.VisualStudio.TextManager.Interop.TextSpan -> Microsoft.VisualStudio.TextManager.Interop.TextSpan
override this.CommentSpan : Microsoft.VisualStudio.TextManager.Interop.TextSpan -> Microsoft.VisualStudio.TextManager.Interop.TextSpan
Public Overridable Function CommentSpan (span As TextSpan) As TextSpan

Parametry

span
TextSpan

TextSpanObjekt popisující rozsah zdroje, který má být přidán do komentáře.

Návraty

TextSpan

Nový TextSpan objekt zahrnující celý rozsah s komentářem, včetně všech počátečních a koncových řetězců komentářů.

Poznámky

Tato metoda určuje, jak nejlépe můžete odkomentovat rozsah tím, že se rozhodujete mezi čárou a blokovým komentářem a potom zavoláte CommentBlock CommentLines metody nebo na rozpětí. Zavolejte GetCommentFormat metodu pro získání řetězců, které definují komentář.

Základní metoda volá GetCommentFormat metodu a poté volá CommentLines metodu, pokud je zadán řetězec komentáře k řádku. v opačném případě volá metodu, CommentBlock Pokud jsou zadány řetězce komentářů bloku. Všimněte si, že tento přístup vždy používá komentáře k řádkům, pokud jsou zadány poznámky řádku a komentář, a to i při komentování bloku textu.

Tato metoda se obvykle volá v reakci na uživatele, který vybere Výběr komentáře k příkazu z nabídky Upřesnit v nabídce Upravit .

Další informace o tom, jak se používá tato metoda, najdete v tématu komentování kódu ve službě starší verze jazyka .

Platí pro