Perguntas com a marcação «documentation-generation»

O Desenvolvimento Orientado a Comportamentos, com sua sintaxe dos cenários emblemáticos "Dado quando", ultimamente tem sido bastante elogiado por seus possíveis usos como um objeto de limite para a avaliação da funcionalidade do software. Concordo definitivamente que o Gherkin , ou o script de definição de recurso que você preferir, …

24 documentation  bdd  documentation-generation  business-rules 

Fechado . Esta questão precisa ser mais focada . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela se concentre apenas em um problema editando esta postagem . Fechado no ano passado . Desejo documentar meu código de forma que haja uma necessidade …

22 documentation  code-reviews  documentation-generation  help-documentation 

Então nós temos uma interface assim /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Recentemente, reproduzimos uma história de documentação que …

20 c#  documentation  xml  documentation-generation 

Atualmente, estou usando dois sistemas para escrever documentação de código (estou usando C ++): A documentação sobre métodos e membros da classe é adicionada ao lado do código, usando o formato Doxygen. Em um servidor, o Doxygen é executado nas fontes para que a saída possa ser vista em um …

13 documentation  documentation-generation  wiki 

Existe um bom termo semelhante, mas diferente de "descontinuar", para significar que um método ou API está na base de código, mas não deve ser usado porque sua implementação não está completa ou provavelmente será alterada? (Sim, eu sei, esses métodos não devem ser públicos, yada yada yada. Eu não …

12 documentation  terminology  api  documentation-generation  javadocs 

Fechado . Esta questão precisa ser mais focada . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela se concentre apenas em um problema editando esta postagem . Fechado há 4 anos . Eu completei um aplicativo Web que é basicamente desenvolvido em …

11 project-management  documentation  documentation-generation  projects-and-solutions 

Documentei meu código doxygen, mas não quero o HTML padrão que ele fornece. Eu sei que posso personalizá-lo fornecendo CSS, cabeçalhos, rodapés personalizados etc. (como o GNOME faz), e como posso adicionar código PHP comum aos arquivos e pedir para que ele salve como .php, mas não é exatamente isso …

10 documentation  templates  documentation-generation 

Eu desenvolvi algumas bibliotecas quantitativas em C # onde é importante entender não apenas as informações clássicas que acompanham os comentários XMLDoc (que contêm informações básicas com a assinatura do método), mas também as fórmulas matemáticas usadas nos métodos. Por isso, gostaria de poder incluir documentação estendida com o código, …

8 documentation  documentation-generation