Source.CommentSpan, méthode

Article
08/01/2012

Commente l'étendue spécifiée de la source.

Espace de noms : Microsoft.VisualStudio.Package
Assemblys :   Microsoft.VisualStudio.Package.LanguageService.10.0 (dans Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (dans Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (dans Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (dans Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntaxe

'Déclaration
Public Overridable Function CommentSpan ( _
    span As TextSpan _
) As TextSpan

public virtual TextSpan CommentSpan(
    TextSpan span
)

Paramètres

span
Type : Microsoft.VisualStudio.TextManager.Interop.TextSpan
Un objet d'TextSpan décrivant l'étendue de la source pour commenter.

Valeur de retour

Type : Microsoft.VisualStudio.TextManager.Interop.TextSpan
Un nouvel objet d'TextSpan entourant commentée l'étendue entière, y compris des chaînes de début de commentaire et de fin.

Remarques

Cette méthode détermine comment mieux commenter l'étendue en décidant entre la ligne et le bloc commente, puis appelle l'CommentBlock ou les méthodes d'CommentLines sur l'étendue.Appelez la méthode d'GetCommentFormat pour obtenir les chaînes qui définissent un commentaire.

La méthode de base appelle la méthode d'GetCommentFormat, puis appelle la méthode d'CommentLines si la chaîne de commentaire de ligne est spécifiée ; sinon, appels la méthode d'CommentBlock si les chaînes de commentaire de bloc sont spécifiées.Notez que cette approche utilise toujours des commentaires de ligne si les deux visualisant et le commentaire des chaînes de commentaire de bloc sont spécifiés -- même lorsque commentant un bloc de texte.

Cette méthode est en général appelée en réponse à l'utilisateur sélectionnant la commande Sélection de commentaire du menu d'Avancé sur le menu d'Edit.

Consultez Commentant le code (managed de package) pour plus d'informations sur cette méthode est utilisé.

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.