2016-01-10 1 views
0

L'ajout de références aux commentaires est assez bien documenté et fonctionne bien pour la liaison entre les éléments dans Visual Studio.Comment ajouter une référence aux commentaires généraux dans C#?

/// text for class TestClass 
public class TestClass 
{ 
    /// <summary>DoWork is a method in the TestClass class. 
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para> 
    /// <seealso cref="TestClass.Main"/> 
    /// </summary> 
    public static void DoWork(int Int1) 
    { 
    } 

    /// text for Main 
    static void Main() 
    { 
    } 
} 

Mais comment l'obtenir dans les commentaires généraux? Où vous pouvez avoir des blocs de commentaires au-dessus de l'espace de noms, ou dans le code général où vous avez besoin d'autres programmeurs pour voir plus que le code. Lorsque j'essaie ce qui suit, Visual Studio n'a rien de spécial, contrairement à /// et précède une classe ou une méthode.

/* 
    First Line to Comment. Maybe a Copyright 
    Second Line to Comment 
    Third Line to Comment 
    Some other junk where users should look at <seealso cref="TestClass.Main"/>  
*/ 

Répondre

0

Cela ne fonctionne que dans le document-commentaires, également appelés XML commentaires introduits par ///.

C# peut créer des fichiers XML à partir de ces commentaires si l'option correspondante est définie dans les options du projet. Des outils externes tels que Sandcastle Help File Builder ou NDoc peuvent créer des fichiers d'aide en utilisant les informations contenues dans les fichiers XML et les informations renvoyées par les assemblys.

Ces références sont insérées dans les fichiers d'aide résultants. Ils auraient peu de sens dans les commentaires ordinaires, car ceux-ci sont ignorés par le compilateur C#.

Mais Sandcastle Help File Builder et NDoc vous permettent d'ajouter un résumé du projet et des commentaires de synthèse d'espace de noms pour les fichiers d'aide générés.

0

Je pense que l'idée est que vous ne le faites pas.

Les commentaires de barre oblique triple sont définis comme des balises de documentation XML et peuvent être analysés par VS et transformés en documentation Web.

Mais les commentaires généraux à double barre oblique et à lignes multiples sont simplement totalement ignorés.