Jump to content
Bbruno

Software para documentar código fonte

Recommended Posts

Bbruno

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

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.

  • Vote 1

Share this post


Link to post
Share on other sites
XsTeAl

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
Bbruno

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

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.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

×
×
  • Create New...

Important Information

By using this site you accept our Terms of Use and Privacy Policy. We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.