Kendi belgelerimde this MSDN page konusundaki açıklamalar bölümünde sarı 'Not:' kutusuna benzer bir şey elde etmek istiyorum.C# xml belgeleri: Notlar nasıl oluşturulur?
Sandcastle ve sandcastle yardım dosyası oluşturucusunu kullanarak dokümantasyon etiketlerinden bir referans web sitesi oluşturuyorum. Böyle bir not kutusuna ulaşmak için ne yazmam gerekiyor?
/// <summary><c>Increment</c> method increments the stored number by one.
/// <note type="caution">
/// note description here
/// </note>
/// </summary>
Bak "C: \ Program Files \ Sandcastle \ Örnekler \ Sandcastle \ Test.cs"
Tip olabilir biri:
değil doğrudan bir çözüm, ancak alternatif:
NDoc bir <note> Etiket destekler. NDoc güncelliğini yitirdiğinden, bu özelliğe bir göz atmanız yeterli olacaktır. Bu, aynı zamanda asp.net'i kabul eden çevrimiçi dokümantasyonun yanı sıra düz HTML belgeleri de oluşturabildiğinden kesinlikle bakmaya değer. dosya
Teşekkür uygulamak, ama bizim altyapı zaten SC dayanır ve kolayca değiştirilemez. –
Serin. Bu sadece çalışır! Etiketi 'resmi' listesinde bulamadık, ancak NDoc etiketlerinin de desteklendiğini bilmek güzel. –
Evet. Resmi olarak desteklenmez, ancak SandCastle tam olarak NDoc ile ilham almıştır: http://blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – chopikadze
THX, +1 benden. Sadece bir yan not: Ben genellikle s'yi bölümüne dahil etmemelisiniz. daha uygun olmalıdır. –