2008-12-26 9 views
6

XML belgesinde C# için yorumlar, birbiri ardına aşırı yüklenme olmak için iki veya daha fazla işlevi işaretlemenin bir yolu var mı? İdeal olarak, onlar da bir şekilde sandcastle tarafından üretilen belgelerde gruplandırılacaklardı.C# XML yorumlarındaki aşırı yüklenmeler/gruplar nasıl bağlanır?

Amaç: Sıklıkla, bu işlev grubuna bağlanmak istiyorum, ör. Faydalı fonksiyonların bir listesinde, sadece aşırı yüklenmelerden birini belirtin ve diğerlerini buradan kolayca keşfedilebilir hale getirin.

Şu anda bağlantı ekliyorum ama bu çok sıkıcı.

cevap

2

Çoklu aşırı yüklenmeler arasındaki ilişki XMl belgeleri ve Sandcastle tarafından zaten tanımlanmış ve gruplandırılmıştır.

see veya seealso etiketlerini kullanarak diğer üyelere bağlantılar oluşturma.

Ör.

///See <see cref="M:AnotherMethod(System.String)"> 

Sandcastle üye çözünürlüğünün biraz kesintili olabileceğinden, tam anlamıyla adlar kullanma eğiliminde olduğumu buldum.

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)"> 

Not M: bir üyeye başvuruda bulunulduğunu belirtir, ayrıca bir Olayı işaret etmek için E: yi kullanırsınız. T: tip için kullanılır, ancak mevcut değilse kabul edilir.

1

Gruplama Sandcastle sağ tarafından otomatik olarak yapılır, ancak sen aşırı yük grubuna ortak bir tanım vermek (< özet > aynı şekilde) bunun için < aşırı yükler > etiketi kullanmak istiyorum. Standart bir XML belge etiketi değil, AFAIR, Sandcastle Yardım Dosyası Oluşturucusu tarafından desteklenir.

+0

Bu oldukça tatlıdır. Etiketler özelliklerinde çevrimiçi dokümanlar var mı? – smaglio81