Pertanyaan Apakah tag dokumentasi C # itu? [Tutup]


Dalam tag dokumentasi C # memungkinkan Anda untuk menghasilkan output yang mirip dengan MSDN. Apakah daftar tag yang diijinkan untuk digunakan di dalam area komentar /// (triple slash) di atas kelas, metode, dan properti?


32
2017-09-15 19:29


asal


Jawaban:


Periksa Dokumentasi hebat tentang berbagai tag dokumentasi C # XML. (Pergi ke bawah untuk melihat tag)


6
2017-09-15 19:31



Jika Anda mengetik ini tepat di atas metode atau kelas, intellisense akan meminta Anda dengan daftar tag yang tersedia:

/// <

12
2017-09-15 19:34



Berikut daftarnya:

  • ringkasan
  • param
  • kembali
  • contoh
  • kode
  • Lihat
  • Lihat juga
  • daftar
  • nilai
  • mengajukan
  • hak cipta

Inilah contohnya:

<file>
<copyright> (c) Extreme Designers Inc. 2008. </ copyright>
<datecreated> 2008-09-15 </ datecreated>
<ringkasan>
Inilah ringkasan saya
</ ringkasan>
<komentar>
<para> The <see cref = "TextReader" /> dapat digunakan dengan cara-cara berikut: </ para>
<jenis daftar = "nomor">
<item> item pertama </ item>
<item> item kedua </ item>
</ daftar>
</ komentar>
<example>
<code>
System.Console.WriteLine ("Hello, World");
</ code>
</ contoh>
<Param name = "aParam"> Param pertama saya </ param>
<return> sebuah objek yang mewakili ringkasan </ return>
</ file>

10
2017-09-15 19:47



Artikel MSDN dari tahun 2002 merinci semua tag dan kapan menggunakannya:

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx


3
2017-09-15 19:31



GhostDoc membantu dengan membuat komentar rintisan untuk metode / kelas Anda.


3
2017-09-15 19:33



Lihat artikel MSDN yang sangat bagus sini sebagai pemberhentian pertama Anda.


2
2017-09-15 19:31



Lihatlah di dalam dokumen untuk Sandcastle. Ini adalah standar dokumentasi baru untuk .NET.


1
2017-09-15 19:52