Documentação-gerador para Objective-C? [fechadas]

Question

Existe um gerador de documentação geralmente aceitos para Objective-C (semelhante ao RDoc para Ruby)? Eu vi Doxygen e ObjcDoc, e estou querendo saber o que é mais utilizado.

Answer 1

Doxygen é provavelmente a opção mais utilizada. Porque não é apenas para ObjC (doxygen suporta muitos outros idiomas), o desenvolvimento é animada e a comunidade bastante forte. HeaderDoc (agora um projeto open source), por comparação parece ter grande parte estagnado . HeaderDoc só produz saída HTML, enquanto doxygen também produz PDF, LaTeX e muitas outras formas de saída, além de HTML. Até mesmo a Apple parece recomendar doxygen, com este guia para produzindo automaticamente conjuntos de documentação, compatível com visualizador de ajuda do Xcode, de dentro de seu processo de construção Xcode.

É importante notar que doxygen pode ler comentários no estilo HeaderDoc, assim você pode escrever sua documentação no estilo HeaderDoc e decidir mais tarde se para produzir o resultado final utilizando doxygen ou HeaderDoc.

Answer 2

Confira appledoc . É baseado em Doxygen . Você pode ver que ele come sua própria comida de cachorro na medida em que gera a documentação de referência appledoc para o código fonte appledoc . Compare, por exemplo, GBComment.h para GBComment Classe Referência

• appledoc: como escrever comentários
• exemplos appledoc de linha de comando configurações

Além disso, dê uma olhada em documentação do Xcode Guia Set para obter instruções completas sobre como criar documentação que trabalha com Xcode. Estas são as instruções que automatiza appledoc.

Answer 3

Doxygen é muito utilizado. Parece-me usá-lo como uma resposta SO uma vez por semana, também.

Answer 4

A nova ferramenta é Jazzy por Realm, que gera documentação no novo estilo Xcode 6 e suportes documentação geradora Swift (bem como objectivo-C).

Answer 5

Assim como doxygen, a Apple tem uma ferramenta a vem com as ferramentas de desenvolvimento. Ele gera o tipo de documentação que você vê em coisas como o enquadramento SystenConfiguration. A ferramenta é chamada HeaderDoc a documentação pode ser encontrada no HeaderDoc Usuário Guia .

Answer 6

Talvez você deve tentar jazzy por Realm . É um projeto open source. jazzy suporta tanto Objective-C & Swift.

"A saída coincide com a aparência de documentação de referência oficial da Apple, postar WWDC 2014." Que você pode julgar a partir da doc amostra que ele proporciona.