Commentant le code (managed de package)
Les langages de programmation fournissent généralement des méthodes pour annoter ou de commentaire du code. Un commentaire est une section de texte qui fournit des informations supplémentaires à propos de le code mais est ignoré lors de la compilation ou la traduction.
Les classes managées du package (MPF) fournissent une prise en charge de commentaires et d'annuler les marques de commentaire du texte sélectionné.
styles de commentaire
Il existe deux styles généraux de commentaire :
La ligne commentaires, où est le commentaire sur une seule ligne.
Le bloc de commentaires, où le commentaire peut inclure plusieurs lignes.
Les commentaires de ligne ont en général un caractère de démarrage (ou des caractères), alors que les commentaires de bloc ont des caractères de début et de fin. Par exemple, en c#, démarrage d'un commentaire de ligne avec //, et démarre un commentaire de bloc avec/* et se termine avec *.
Lorsque l'utilisateur sélectionne la commande sélection de commentaire d' Edit - le menu d'> Avancé , la commande est routé vers la méthode d' CommentSpan sur la classe d' Source . Lorsque l'utilisateur sélectionne la commande Supprimez les marques de commentaire de la sélection, la commande est routée vers la méthode d' UncommentSpan .
commentaires de code de prise en charge
Vous pouvez disposer commentaires du code de stockage après-vente de langage via EnableCommenting nommé paramètre d' ProvideLanguageServiceAttribute . Cela définit la propriété d' EnableCommenting de la classe d' LanguagePreferences . Pour plus d'informations sur les fonctionnalités de servicce de langage de paramètre, consultez Enregistrement d'un service de langage (managed de package)).
Vous devez également substituer la méthode d' GetCommentFormat pour retourner une structure d' CommentInfo avec les caractères de commentaire pour votre langage. les caractères de style de la c# de commentaire de la ligne est la valeur par défaut.
Exemple
voici un exemple d'implémentation de la méthode d' 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;
}
}
}
Voir aussi
Concepts
Enregistrement d'un service de langage (managed de package)