VS 2010 C# XML belgelerinden HTML/Yardım dosyaları oluşturun

Question

VS2010 XML belgelerimden HTML/Yardım dosyaları oluşturma konusunda iyi bir araç arıyorum. Ben sadece örnek olarak bu ikisini listelemek, böyle

VSDocman

Daha vardır eminim

• .Net documentation tool
olarak, bazı ticari araçlar bulduk. Ayrıca XML'i HTML belgelerine dönüştürmek için basit XSLT biçembentleri vardır.

Ne kullanıyorsunuz, ör. Dönüştürme yapmak için belki de eklenti olarak ücretsiz bir araç var. Sadece temelde ben araçları iki tür bulduk netleştirmek için:

1. farklı hedef formatlarında XML belgeleri dosya dönüştürme olanlar, bu aradığım şeydir.
2. Kaynak kodunda XML belgelerini oluşturmama yardımcı olan araçlar. Bu (!) Aradığım şey değil.

Yardımlarınız için teşekkürler.

---

Sandcastle/SHFB combo mükemmel çalışır. Yardım eden herkese teşekkürler.

Bazı açıklamalar:

1. Ndoc modası geçmiş gibi görünüyor, son güncellemeler bu atlanır neden 2005 den budur bulunmaktadır.
2. Benzer bir konu, ayrıca çok ayrıntılı, burada bulunabilir: How to turn C# Xml Doc-Comments into something useful? İpucu için teşekkürler! http://sandcastle.codeplex.com/
3. MsHelp2 üretmek amacıyla ben hscomp.exe içeren VS 2008 SDK yüklemek zorunda:
4. Burada yer alan bulduk Sandcastle, son sürümü için bazı kaynaklar vardır. Sürüm 1.0 ve 1.1, sürüm 1.0'ın derleyiciyi içerdiğini anlayabildiğim kadarıyla var. Bazı ayrıntılar için bkz. Helixsoft ve Social MSDN.
5. Benim durumumda oluşturulan WebHelp, Chrome ile düzgün çalışmıyor. Her zaman index.html sayfasını yeniden yükler.
6. topic here, ad alanı bilgilerinin sandcastle belgelerine nasıl ekleneceğini gösterir.
7. Kasım 2012'den itibaren güncelleştirme: Daha küçük projeler için Doxygen kullanıyorum - Yapılandırmayı biraz daha kolay buluyorum. XML yorumlardan belgelerin oluşturulmasına olanak

Answer 1

Yardım projelerini yönetmek için kullanıcı arabirimi olarak Sandcastle Yardım Dosyası Oluşturucu'yu dönüşüm için & Sandcastle kullanıyoruz. Sandcastle ve SHFB'nin görüşüne göre, "ortalama" kaynak kodu dokümantasyonunun yanında, programın mimarisi, izlenecek kalıplar veya projenize bağlı olmayan herhangi bir ek kavramsal içerik gibi ek bilgiler ekleyebilirsiniz. programınızda doğrudan bir sınıfa. Bu, Microsoft Authoring Schema'nın yardımıyla ek xml dosyaları oluşturarak yapılabilir (xml dosyası olarak görsel stüdyosuyla düzenlenebilir ve şema kullanılabilir). MSDN gibi belgelerin oluşturulması için her iki araçla başlaması oldukça kolaydır.

Uzun bir süre önce teknik açıdan neredeyse aynı olan bir dokümanı denedim (bilgi ve xslt dosyalarını içeren xml dosyaları çeşitli çıktı türlerine dönüştürmek için). Ama bizim için bir seçenek değildi, çünkü görsel stüdyosu tarafından oluşturulan xml belgelerini kullanabilecek bir dönüşüm yok (artı kavramsal içeriklerin dönüşümü bizim için oldukça acı verici).

Answer 2

iki tane daha serbest araçları:

• NDoc
• Sandcastle

Answer 3

Sandcastle + SHFB büyük bir combo.Ücretsiz ve html, chm, vb. Üretir.