2010-05-15 15 views
8

Doğrudan Visual Studio'dan koddaki belgelerden okunabilir bir belge dosyası oluşturmanın bir yolu var mı?Bir CHM veya HTML dosyasına C# dökümantasyonu nasıl oluşturulur?

/// <summary> 
/// Convert a number to string 
/// </summary> 
/// <param name="number">An integer number to be converted to string</param> 
/// <returns>Number as string</returns> 
/// <example> 
/// <code> 
///  var s = MyMethod(5); 
/// </code> 
/// </example> 
/// <exception cref="Exception">In case it can't convert</exception> 
/// <remarks> 
/// Whatever 
/// </remarks> 
public string MyMethod(int number) 
{ 
    return number.ToString(); 
} 

cevap

4

VSdocman Visual Studio doğrudan yapabilirsiniz.

+1

Harika bir araç! Zaten Visual Studio 2010 ile çalışıyor, kullanımı çok kolay ve harika belgeler oluşturuyor. – BrunoLM

9

Kullanım DocProject:

Kod örneği (ayrıca 2010 göz önünde bulundurarak). HTML dokümanları da oluşturabilir. Önce Sandcastle'u yüklemelisiniz.

+0

1 olduğunu :) –

+0

Benim Windows 7 x64 üzerinde çalışmıyor. DocProject her zaman çöküyor – BrunoLM

+0

VS2010 içinde mümkün mü? – Saint

4

Kontrol dışarı doxygen

+0

+1. IMO Kullanımı daha kolay ve daha güzel görünen sonuçlar – user430788

2

Sandcastle Help File builder bunu beni dövdüğü için bir tane

+0

Bu en iyisidir. VS2010, VS2012, VS2013 ve muhtemelen yıl sonunda VS2014 desteği vardır. MS Word, HTML, CHM ve diğer Yardım formatlarına dışa aktarabilirsiniz. –

İlgili konular