como processar um ficheiro readme com rdoc para exibir script ruby ajuda/informações de uso

Question

Eu gostaria de manter meu uso documenation em um arquivo leiame (duh), em vez de comentários na parte superior do meu script.Como faço para obter RDoc::de uso para puxar o uso de informações do arquivo leiame, em vez de o script comentários?

Answer 1

RDoc é projetado para analisar um arquivo de origem, olhar os comentários e as respectivas localizações, criar referências das variáveis, e, ao terminar, amarre-as em uma boa saída.Porque RDoc é projetado para trabalhar contra arquivos de origem pode não ser a melhor escolha para o que você quer fazer.

Em vez disso, você pode querer olhar para Estaleiro, que é baseado em tags. Posso receber meu LEIAME.têxteis para a minha RDoc com formatação adequada? tem algumas informações úteis para você também.

Em qualquer caso, se você não pode obter o aplicativo para analisar um ficheiro leia-me-tipo de doc que você quiser, você pode ser capaz de imite-a, colocando todos os seus documentos no arquivo, juntamente com a classe e o método de stubs para os analisadores pode pegar os parâmetros, variáveis globais, e outros "outras coisas" que eles precisam para criar documentação utilizável.

Caso contrário, você provavelmente vai ter que abrir mão de utilizar o automatizado de ajuda e escreva tudo.

Minha recomendação é fazê-lo o RDoc forma, e documento dentro de seu código.Não é difícil de fazer, e o resultado pode ser muito satisfatório.É incrível como um bom trabalho de RDoc pode fazer.

Answer 2

Certamente não tenho experiência o suficiente para lhe dizer a resposta, mas por favor me permita um conselho.

É improvável que a maioria dos desenvolvedores atualize a documentação, mesmo que sejam três linhas de código acima da implementação.

Faça um favor e não torne o processo ainda mais difícil.

Manter a documentação geral separada é uma boa idéia, mas não tem nada a ver na sua saída gerada pelo RDOC de qualquer maneira.