Bbruno 0 Report post Posted June 11 Bom dia, estou á procura de uma solução online e opensource de preferência que dê para instalar no servidor para documentar o código fonte ( php, js,css ). Objectivo é conseguir identificar cada ficheiro, cada função e para que serve cada uma delas e colocar exemplos de utilização da mesma. Uma solução que seja fácil de consultar e inserir, actualizar informação. Já vi várias soluções mas a sua instalação requer demasiadas coisas e não me inspira confiança no caso de algo correr mal no servidor, eu procurava uma coisa simples de utilizar. Que soluções conhecem que queiram recomendar? Obrigado pela ajuda Share this post Link to post Share on other sites
Rui Carlos 352 Report post Posted June 13 O que procuras é gerar a documentação em formato web, ou para escrever a documentação online? Para o primeiro caso, o Doxygen ou o Sphinx devem servir. Para o segundo caso não faço ideia. 1 Rui Carlos Gonçalves Share this post Link to post Share on other sites
XsTeAl 2 Report post Posted June 19 Para documentar API's conheço o https://apiary.io/ Tens muitos parecidos e certamente mais em conta (€). Como o Rui Carlos disse o para geração de documentação podes usar o Doxygen. Share this post Link to post Share on other sites
Rui Carlos 352 Report post Posted June 19 Para APIs REST costumo usar o ReDoc: https://github.com/Redocly/redoc Rui Carlos Gonçalves Share this post Link to post Share on other sites
Bbruno 0 Report post Posted June 20 Já tentei algumas dessas ferramentas mas a instalação e requisitos não me convencem, o resultado final que pretendia seria algo deste género: https://developer.wordpress.org/reference/functions/ colocamos a função do nosso código e descrição, nome fisico, caminho e em que projectos está a ser utilizado, pode levar revisões e notificação de bugs, eu não queria reinventar a roda mas não estou a achar nada que faça isto de uma forma directa. Obrigado Share this post Link to post Share on other sites
Rui Carlos 352 Report post Posted June 20 A documentação do WordPress parece-me similar ao que o Doxygen faz. O Doxygen tem uma quantidade brutal de funcionalidades e configurações, mas há medida que começas a querer funcionalidades mais avançadas, também começas a ter que ajustar mais configurações, e a explorar mais comandos. 2 horas atrás, Bbruno disse: colocamos a função do nosso código e descrição, nome fisico, caminho e em que projectos está a ser utilizado, pode levar revisões e notificação de bugs, Mas o teu objectivo é escrever a documentação "online", no tal software de documentação que procuras? Para esse tipo de documentação o normal é a mesma ser extraída do código fonte. Isto é, colocas comentários com um formato especial no código, e o software de documentações gera um portal web com a documentação. Um exemplo: https://developer.wordpress.org/reference/functions/absint/ Esta página é gerada a partir dos comentários que tens no código fonte aqui. Os links Related são gerados automaticamente a partir do uso de funções. E muito provavelmente o changelog é gerado a partir dos comentários @since. Rui Carlos Gonçalves Share this post Link to post Share on other sites
Bbruno 0 Report post Posted August 7 Boa tarde, obrigado pela ajuda, acabei por encontrar: https://app.gitbook.com tem um motor de pesquisa, permite ser publico e privado e trabalhar em equipa, faz algumas ligações/integrações e documentar o código de forma simples e directa, não precisa de instalação é só criar a conta e trabalhar Share this post Link to post Share on other sites
