Bir GhostDoc türü araç için alternatif araç

Question

İşlev veya olay işleyicileri verirsek (iyi bir araç olmadığını hissettiğimiz GhostDoc gibi) kodun açıklamalarını (açıklamalarını) oluşturacak .NET için bir araç var mı?

Answer 1

Eğer VS2010'da /// ile bir yorum başlatırsanız, yorum yaptığınız işleve bağlı olarak XML'de temel parametreler oluşturacaktır. Eğer bunlardan iyi belgeleri oluşturmak isteyen konum

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

Yani

/// <summary> 
/// 
/// </summary> 
/// <param name="scope"></param> 
static void startMonitor(ManagementScope scope) 

... startMonitor(ManagementScope scope) verir işlevi önce /// yazarak, senin ilk durağı olarak https://github.com/EWSoftware/SHFB düşündürmektedir. Güzel bir as.

Answer 2

Sandcastle'a bir göz atın. Visual   Studio   2005 projeleri ile çalışacaktır. nDoc için hala indirmeler de var. 2005'in etrafında heybetliydi, ama bence o zamandan beri çok az gelişme ya da gelişme gerçekleşmedi.

Aslında sizin için kod yorumlarını önceden dolduracak bir şey arıyorsanız, GhostDoc'tan daha iyisini yapabileceğinizden emin değilim.

Answer 3

Aslında, /// hiçbir belge oluşturmaz, yalnızca XML etiketleri boşaltın. Nerede GhostDoc parlar vb mülkiyet, sınıf, görünürlük, kullanımlar gibi bağlamsal bilgilere dayanarak, otomatik olarak (şişirme dahil) MSDN tarzı belgeler üreten içindedir

İşte bazı gerçek alternatif:

• Atomineer (bit GhostDoc'tan daha ucuz)
• Yeniden Eşleştirme (yalnızca proje için XML Yorumları'nı etkinleştirirseniz çalışır, ancak yukarıdaki iki taneye yakın bir yere yakın değildir. Ayrıca, XML yorumlarını temel sınıflardan/arabirimlerden kopyalayabilirsiniz). Şimdi

, ne yaparsan yap, undocumentation üretmek etmeyiniz! :)