Visual Studio'da işlev için IntelliSense'te nasıl yorum yapılır?

Visual Studio ve C # 'da, ToString () gibi yerleşik bir işlev kullanıldığında IntelliSense, ne yaptığını açıklayan sarı bir kutu gösterir.

Yazdığım işlevler ve özellikler için buna nasıl sahip olabilirim?

İşlev için bir açıklama ve işlev için her bir parametre belirtebileceğiniz bir alan oluşturmak için, işlevinizden önceki satıra aşağıdakini yazın ve tuşuna basın Enter:

• C #: ///

• VB: '''

Bu yorumlara ekleyebileceğiniz yapılandırılmış içerik hakkında daha fazla bilgi için Dokümantasyon Yorumları için Önerilen Etiketler (C # Programlama Kılavuzu) konusuna bakın .

İhtiyacınız olan şey xml yorumlarıdır - temel olarak, bu sözdizimini takip ederler (Solmead tarafından belirsiz bir şekilde açıklandığı gibi):

C #

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

<c>text</c>- Kod olarak belirtmek istediğiniz metin.
< C > etiketi, bir açıklama içindeki metnin kod olarak işaretlenmesi gerektiğini belirtmek için bir yol sağlar. Birden çok satırı kod olarak belirtmek için < kod > kullanın .

<code>content</code>- Kod olarak işaretlenmesini istediğiniz metin.
< Code > etiketi, birden çok satırı kod olarak belirtmeniz için bir yol sağlar. Bir açıklama içindeki metnin kod olarak işaretlenmesi gerektiğini belirtmek için < c > tuşunu kullanın .

<example>description</example>- Kod örneğinin açıklaması.
< Example > etiketi, bir yöntemin veya başka bir kütüphane üyesinin nasıl kullanılacağına ilişkin bir örnek belirlemenizi sağlar. Bu genellikle < kod > etiketinin kullanılmasını içerir .

<exception cref="member">description</exception>- İstisna açıklaması.
< İstisna > etiketi hangi istisnaların atılabileceğini belirlemenizi sağlar. Bu etiket, yöntemler, özellikler, olaylar ve dizinleyiciler için tanımlara uygulanabilir.

<include file='filename' path='tagpath[@name="id"]' />
< İnclude > etiketi, kaynak kodunuzdaki türleri ve üyeleri açıklayan başka bir dosyadaki yorumlara başvurmanıza olanak tanır. Bu, dokümantasyon yorumlarını doğrudan kaynak kodu dosyanıza yerleştirmenin bir alternatifidir. Belgeleri ayrı bir dosyaya koyarak, kaynak denetimini belgelere kaynak kodundan ayrı olarak uygulayabilirsiniz. Bir kişi kaynak kod dosyasını teslim alabilir ve bir başkası da belge dosyasını teslim alabilir. < İnclude > etiketi XML XPath sözdizimini kullanır. < İnclude > kullanımınızı özelleştirmenin yolları için XPath belgelerine bakın .

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

< Listheader > bloğu, bir tablonun veya tanım listesinin başlık satırını tanımlamak için kullanılır. Bir tablo tanımlarken, yalnızca başlıktaki terim için bir giriş sağlamanız gerekir. Listedeki her öğe bir < item > bloğu ile belirtilir . Bir tanım listesi oluştururken hem terim hem de açıklama belirtmeniz gerekir. Ancak, bir tablo, madde işaretli liste veya numaralı liste için, açıklama için yalnızca bir giriş sağlamanız gerekir. Bir liste veya tabloda gerektiği kadar < öğe > bloğu bulunabilir.

<para>content</para>
< Para > etiketi, < özet >, < açıklamalar > veya < döner > gibi bir etiketin içinde kullanım içindir ve metne yapı eklemenizi sağlar.

<param name="name">description</param>
Yöntemin parametrelerinden birini tanımlamak için yöntem bildirimi için açıklamada < param > etiketi kullanılmalıdır. Birden çok parametreyi belgelemek için birden fazla < param > etiketi kullanın.
< Param > etiketi metni IntelliSense'te, Nesne Tarayıcısında ve Kod Açıklaması Web Raporunda görüntülenir.

<paramref name="name"/>
< Paramref > etiketi, kod açıklamalarındaki bir kelimenin, örneğin bir < özet > veya < açıklamalar > bloğundaki bir parametreye işaret ettiğini belirtmek için bir yol sağlar. XML dosyası, bu sözcüğü kalın veya italik yazı tipinde olduğu gibi farklı bir şekilde biçimlendirmek için işlenebilir.

< permission cref="member">description</permission>
< İzin > etiketi, bir üyesinin erişim belgelemek sağlar. PermissionSet sınıfı bir üyeye erişimi belirlemenizi sağlar.

<remarks>description</remarks>
< Açıklamalar > etiketi, < özet > ile belirtilen bilgileri tamamlayan bir tür hakkında bilgi eklemek için kullanılır . Bu bilgiler Nesne Tarayıcısında görüntülenir.

<returns>description</returns>
Dönüş değerini tanımlamak için bir yöntem bildirimi için açıklamada < return > etiketi kullanılmalıdır.

<see cref="member"/>
< See > etiketi, metnin içinden bir bağlantı belirtmenize olanak tanır. Metnin Ayrıca Bkz. Bölümüne yerleştirilmesi gerektiğini belirtmek için < seealso > öğesini kullanın . Kod öğeleri için belge sayfalarına dahili köprüler oluşturmak için cref Attribute özelliğini kullanın.

<seealso cref="member"/>
< Seealso > etiketi Ayrıca Bkz. Bölümünde görünmesini isteyebileceğiniz metni belirtmenize olanak tanır. Metin içinden bir bağlantı belirtmek için < see > tuşunu kullanın .

<summary>description</summary>
Bir tür veya bir tür üyeyi tanımlamak için < özet > etiketi kullanılmalıdır. Bir tür açıklamasına ek bilgi eklemek için < açıklamalar > seçeneğini kullanın . Kod öğeleri için belge sayfalarına dahili köprüler oluşturmak üzere Sandcastle gibi belge araçlarını etkinleştirmek için cref Attribute özelliğini kullanın. < Özet > etiketi metni , IntelliSense'teki türle ilgili tek bilgi kaynağıdır ve Nesne Tarayıcısında da görüntülenir.

<typeparam name="name">description</typeparam>
< Typeparam > etiketi, açıklamada bir tür parametresini tanımlamak için genel bir tür veya yöntem bildirimi için kullanılmalıdır. Genel tür veya yöntemin her tür parametresi için bir etiket ekleyin. < Typeparam > etiketi metni , Nesne Tarayıcısı kod açıklaması web raporu olan IntelliSense'te görüntülenecektir.

<typeparamref name="name"/>
Belge etiketindeki tüketicilerin sözcüğü belirli bir şekilde, örneğin italik olarak biçimlendirmesini sağlamak için bu etiketi kullanın.

<value>property-description</value>
< Value > etiketi, bir özelliğin temsil ettiği değeri tanımlamanızı sağlar. Visual Studio .NET geliştirme ortamında kod sihirbazı yoluyla bir özellik eklediğinizde, < , yeni özellik için özet > etiketi . Ardından , özelliğin temsil ettiği değeri açıklamak için el ile bir < değer > etiketi eklemeniz gerekir .

XML yorumlaması yap, böyle

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

yorumun her satırına başlamak için /// kullanın ve yorumun meta veri okuyucusu için uygun xml içermesini sağlayın.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

Şahsen, kodun tüketicileri tarafından okunamayacağı sınıflar geliştirmediğiniz sürece, bu yorumların genellikle yanlış yönlendirildiğine inanıyorum.

Bunlara XML Yorumları denir . Sonsuza kadar Visual Studio'nun bir parçası oldular.

GhostDoc'u kullanarak dokümantasyon sürecinizi kolaylaştırabilirsinizVisual Studio için sizin için XML-doc yorumları üreten ücretsiz bir eklenti olan . Caretinizi belgelemek istediğiniz yönteme / özelliğe yerleştirin ve Ctrl-Shift-D tuşlarına basın.

İşte yayınlarımdan birinden bir örnek .

Umarım yardımcı olur :)

CSharp'ta, yöntemi / işlev anahattını Parms ile oluşturursanız, üç eğik çizgi eklediğinizde otomatik olarak özet ve parms bölümünü oluşturur.

Bu yüzden ben koydum:

public string myMethod(string sImput1, int iInput2)
{
}

Sonra üç /// daha önce koydu ve Visual Studio's bana verdi:

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

Bunun gibi Yöntemleri tanımlayın ve ihtiyacınız olan yardımı alacaksınız.

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

Kod kullanımının ekran görüntüsü

http://msdn.microsoft.com/tr-tr/library/3260k4x7.aspx oku Sadece yorumların belirtilmesi yardım yorumlarını intellisense'de göstermez.

Tüm bu diğer cevaplar mantıklı, ancak eksik. Visual Studio XML yorumlarını işleyecektir, ancak bunları açmanız gerekir. Bunu nasıl yapacağınız aşağıda açıklanmıştır:

Intellisense, kaynak kodunuza girdiğiniz XML yorumlarını kullanacaktır, ancak bunları Visual Studio Seçenekleri'nden etkinleştirmeniz gerekir. Git Tools> Options> Text Editor. Visual Basic için Advanced> Generate XML documentation comments for '''ayarını etkinleştirin . C # için, Advanced>Generate XML documentation comments for /// ayarını . Intellisense, girildiğinde özet yorumları kullanacaktır. Başvurulan proje derlendikten sonra diğer projelerden temin edilebilirler.

Oluşturmak için harici belgelere, çıkan sonuçlara bir XML dosyası oluşturmak için gereken Project Settings> Build> XML documentation file:yolu olduğunu kontroller derleyici'nın /docseçeneği. XML dosyasını girdi olarak alacak ve çıktı biçimleri seçiminizde belgeleri oluşturacak harici bir araca ihtiyacınız olacaktır.

XML dosyası oluşturmanın derleme sürenizi belirgin şekilde artırabileceğini unutmayın.

Ayrıca, visual studio eklenti hayalet dokümanı, işlev adınızdan başlık yorumları oluşturmaya ve doldurmaya çalışacaktır.

Solmead'in cevabı doğru. Daha fazla bilgi için XML Yorumlarına bakabilirsiniz .