C# belgelerinde, MSDN'ye benzer bir çıktı üretmenize olanak tanır. Sınıfların, yöntemlerin ve özelliklerin üzerindeki /// (üçlü eğik çizgi) yorum alanının içinde kullanılmak üzere izin verilen etiketlerin listesi nedir? Tüm etiketleri detaylandırma 2002'denC# dokümantasyon etiketleri nelerdir?
Kontrol dışarı Great documentation on the various C# XML documentation tags. mükemmel MSDN makalesine bakın
MSDN makale ve ne zaman bunları kullanmak için:
(etiketleri görmek için alt git) here ilk durağınız gibi.
GhostDoc senin yöntemi/sınıf için bir saplama yorumunu oluşturarak yardımcı olur.
sadece bir yöntem ya da sınıfın üzerindeki bu yazarsanız, Intellisense mevcut etiketlerin bir listesini size mutlaka yapılmalıdır: Burada
/// <
Bunların hepsi genel olarak ne anlama geliyor? Bunları belirlemek için hangi siparişi kullanmalısınız? Her biri için uygun kullanım durumları ne olurdu? Mümkün olan, ancak modern kalkınma uygulamasında cesaret kırılmış mı? – Neolisk
liste:
dosya
<file>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<datecreated>2008-09-15</datecreated>
<summary>
Here's my summary
</summary>
<remarks>
<para>The <see cref="TextReader"/> can be used in the following ways:</para>
<list type="number">
<item>first item</item>
<item>second item</item>
</list>
</remarks>
<example>
<code>
System.Console.WriteLine("Hello, World");
</code>
</example>
<param name="aParam">My first param</param>
<returns>an object that represents a summary</returns>
</file>
C# – Nap
için bir yazar etiketi yoktur Ya ben daha fazla bilgi için yönlendirmesi gereken bir urlniz varsa? Bunu nereye koyayım? –
@KevinDriedger - Listeyi düzenlemenizi ve "author" etiketini kaldırmanızı öneririm. Bir an için onu orada görmekten memnun oldu ve sonra kendime Nap 'in yorumları olarak okuma ve ona kontrol ettikten sonra hayal kırıklığına uğradım [link verilen] (http://web.archive.org/web/20100118163744/http:// thoughtpad.net/alan-dean/cs-xml-documentation.html) [tarafından David Mohundro] (https://stackoverflow.com/a/65989/978502) – yair
Bak. Bu, .NET için yeni belge standardıdır.
Ne yazık ki, domain sona erdiğini ve bu kırık bağlantıdır. –
Bu kokuyor - Google önbelleği hala var, ama ne kadar süreyle, kim bilir? –
Bunun bir web sayfasına yayınladığınızda, bunun JavaDocs gibi olduğunu varsayalım. Burada daha güncelleştirilmiş link: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx – puretppc