Questão:
Qual ferramenta pode gerar documentação HTML a partir de código C #, como Javadoc pode fazer para Java?
Nicolas Raoul
2014-02-05 06:47:08 UTC
view on stackexchange narkive permalink

Os desenvolvedores Java podem gerar facilmente documentação HTML a partir de seu código Java, que é uma maneira conveniente de postar APIs online. Este é um exemplo.

Existe uma ferramenta semelhante para código C #?

Deve ser gratuito, idealmente de código aberto.

Deve ser executado no Windows e Linux, pelo menos.

Quadros HTML não são necessários, ferramentas que geram apenas uma longa página HTML também é perfeita.

Usamos o [Sandcastle Help File Builder (SHFB)] (https://github.com/EWSoftware/SHFB). É poderoso e gratuito, você pode gerar ajuda .chm e também html.
Quatro respostas:
#1
+16
aman207
2014-02-05 07:10:12 UTC
view on stackexchange narkive permalink

Doxygen parece ser o que funcionaria para você.

  • Ele pode gerar um navegador de documentação on-line (em HTML) e / ou um off manual de referência de linha (em $ \ mbox {\ LaTeX} $) de um conjunto de arquivos de origem documentados.
  • Também há suporte para geração de saída em RTF (MS-Word), PostScript, PDF com hiperlink, HTML compactado e páginas de manual do Unix.
  • A documentação é extraída diretamente dos fontes, o que torna muito mais fácil manter a documentação consistente com o código fonte.

Pode ser usado para gerar documentação de C #, junto com outras linguagens como C, Objective-C, PHP, Java, Python.

Acabei de experimentar o Doxygen, funciona perfeitamente, muito obrigado!
#2
+16
Lyndon White
2014-02-05 12:29:56 UTC
view on stackexchange narkive permalink

Você pode fazer isso com o compilador Microsoft C # normal. Embora não seja de código aberto. Sem dúvida, é gratuito, pois usa ferramentas que você já possui.

Para o arquivo C # chamado XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

produzirá o arquivo xml XMLsample.xml . Ao aplicar uma folha de estilo a isso, você terá um ótimo site. CSS deve servir, embora para uma reforma mais significativa você precise usar XSLT.

veja MSDN


Também está disponível no Mono C # compilador. Mono C # é gratuito e de código aberto.

  mcs XMLsample.cs /doc:XMLsample.xml  

Consulte Página de manual mono

Isso não pode gerar a documentação de um arquivo C # sem o método Main (). Existe algum outro comando para isso?
As perguntas @Riky sobre o uso de software são mais adequadas para superusuário ou, neste caso, stackoverflow
#3
+5
xpt
2017-02-28 02:54:20 UTC
view on stackexchange narkive permalink

Colocando meu 2c porque estava seguindo a resposta aceita, mas descobri,

O compilador Microsoft C # está fazendo um trabalho incompleto. Ou seja, ele fornece apenas um arquivo xml. Mas para ter um bom site, você ainda terá que aplicar alguma folha de estilo a ele, e é aí que a ponte é quebrada - o compilador C # da Microsoft não faz isso, e as ferramentas de suporte da Microsoft que fazem isso, o Sandcastle Projeto CodePlex, não está mais em desenvolvimento ativo pela Microsoft.

Resumindo, a resposta aceita pode ser boa para o ano de 2014, mas não é mais boa para 2017.

A nova resposta é Construtor de arquivos de ajuda do Sandcastle strong de Eric Woodruff > site em https://GitHub.com/EWSoftware/SHFB, que é bifurcado e baseado no código-fonte existente do Sandcastle.

#4
+2
David Thielen
2014-07-30 19:51:36 UTC
view on stackexchange narkive permalink

Usamos Documento! X e funciona muito bem para nós. Você obtém os documentos completos da API a partir dos comentários e as folhas de estilo tornam a aparência muito bonita. Eles também respondem muito bem ao suporte.

Dito isso, não é gratuito. Mas pelo que oferece, acho que vale a pena. (Antes usávamos um programa gratuito, não o doxygen, e isso acabou sendo muito caro em termos de tempo que levava.)



Estas perguntas e respostas foram traduzidas automaticamente do idioma inglês.O conteúdo original está disponível em stackexchange, que agradecemos pela licença cc by-sa 3.0 sob a qual é distribuído.
Loading...