Doxygen/pt-br: Revision history

Diff selection: Mark the radio buttons of the revisions to compare and hit enter or the button at the bottom.
Legend: (cur) = difference with latest revision, (prev) = difference with preceding revision, m = minor edit.

(newest | oldest) View (newer 50 | ) (20 | 50 | 100 | 250 | 500)

20 June 2024

19 June 2024

  • curprev 18:5018:50, 19 June 2024Dikluwe talk contribs 44,513 bytes +34 No edit summary
  • curprev 18:5018:50, 19 June 2024Dikluwe talk contribs 44,479 bytes +28 Created page with "Nota: * A primeira opção é preferível para cumprir com [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8], [https://www.python.org/dev/peps/pep-0257/ PEP257] e a maioria das diretrizes de estilo para escrever Python (veja [https://realpython.com/python-pep8/ 1], [https://realpython.com/documenting-python-code/ 2]). Recomenda-se usar esse estilo se você pretende produzir fontes documentadas usando o [https://www.sphinx-doc.org/en/master/ Sphinx],..."
  • curprev 18:4818:48, 19 June 2024Dikluwe talk contribs 44,451 bytes +55 Created page with "Há duas maneiras de escrever blocos de documentação para Python: # O modo pythonico, usando "docstrings", ou seja, um bloco de texto cercado por <code><nowiki>'''aspas triplas'''</nowiki></code> imediatamente após a definição da classe ou função. # O modo Doxygen, colocando os comentários antes da definição da classe ou função; Nesse caso, caracteres de cerquilha dupla {{incode|##}} são usados para iniciar o bloco de documentação e, em seguida, um único..."
  • curprev 18:4218:42, 19 June 2024Dikluwe talk contribs 44,396 bytes +58 Created page with "Com essa configuração feita, o comando {{incode|doxygen Doxyfile}} pode ser executado para gerar a documentação como de costume. Cada arquivo Python usando Pythonic <code><nowiki>'''triple quotes'''</nowiki></code> será reformatado em tempo real para usar comentários de estilo {{incode|##Doxygen}} e, em seguida, será processado pelo Doxygen, que agora será capaz de interpretar os scomandos especiais e a sintaxe Mardown. O..."
  • curprev 18:3818:38, 19 June 2024Dikluwe talk contribs 44,338 bytes +16 Created page with "Observe que os arquivos Python existentes que já usam o estilo {{incode|##double hash}} para seus blocos de comentários {{incode|doxypypy}} não serão afetados pelo filtro e serão processados pelo Doxygen normalmente."
  • curprev 18:3618:36, 19 June 2024Dikluwe talk contribs 44,322 bytes −2 Created page with "Depois de salvar esse shell script, verifique se ele tem permissões de execução e se está localizado em um diretório contido no {{incode|PATH}}."
  • curprev 18:3618:36, 19 June 2024Dikluwe talk contribs 44,324 bytes +15 Created page with "O programa {{incode|doxypypy_filter}} não existe por padrão; ele deve ser criado como um shell script para {{incode|doxypypy}} ser executado com as opções apropriadas e tomar um arquivo como seu primeiro argumento."
  • curprev 18:3518:35, 19 June 2024Dikluwe talk contribs 44,309 bytes +44 Created page with "No novo arquivo, o estilo de comentário é alterado para que a linha se torne {{incode|##@package pyexample_pythonic}}, que agora será interpretada por Doxygen. No entanto, para ser interpretado corretamente, o argumento precisa ser editado manualmente para corresponder ao novo nome do módulo (arquivo); depois de fazer isso a linha deve ser {{incode|##@package pyexample_doxygen}}."
  • curprev 18:3418:34, 19 June 2024Dikluwe talk contribs 44,265 bytes +5 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} (o topo é editado manualmente, o resto permanece o mesmo)"
  • curprev 18:3418:34, 19 June 2024Dikluwe talk contribs 44,260 bytes +8 Created page with "Para compilar, crie a configuração e execute {{incode|doxygen}} no diretório de nível superior que contém os arquivos."
  • curprev 18:3418:34, 19 June 2024Dikluwe talk contribs 44,252 bytes +2 Created page with "A documentação deve mostrar informações semelhantes às seguintes e criar links apropriados para os módulos individuais."
  • curprev 18:3318:33, 19 June 2024Dikluwe talk contribs 44,250 bytes +19 Created page with "O arquivo original tem um comentário na parte superior <code><nowiki>'''@package pyexample_pythonic</nowiki></code> que indica o módulo ou namespace que está sendo descrito pelo arquivo. Essa palavra-chave {{incode|@package}} não é interpretada ao usar aspas triplas no bloco de comentários."
  • curprev 18:3018:30, 19 June 2024Dikluwe talk contribs 44,231 bytes +42 Created page with "Uma vez que o programa {{incode|doxypypy}} é instalado, e acessível a partir do terminal, um arquivo Python com docstrings Pythonic pode ser reformatado para o estilo Doxygen com as seguintes instruções. O programa gera a saída do código reformatado para a saída padrão, portanto, redirecione essa saída para um novo arquivo."
  • curprev 18:2818:28, 19 June 2024Dikluwe talk contribs 44,189 bytes +6 Created page with "Como alternativa, você pode criar um link simbólico para o programa {{incode|doxypypy}}, colocando o link em um diretório que já está incluído no {{incode|PATH}}."
  • curprev 18:2818:28, 19 June 2024Dikluwe talk contribs 44,183 bytes +9 Created page with "Se o pacote foi instalado como um usuário, ele pode residir em seu diretório pessoal, por exemplo, em {{incode|$HOME/.local/bin}}. Se este diretório não estiver no {{incode|PATH}} do seu sistema, o programa não será encontrado. Portanto, adicione o diretório {{incode|$HOME/.bashrc}} à variável {{incode|PATH}}, no arquivo ou no arquivo {{incode|$HOME/.profile}}."
  • curprev 18:2518:25, 19 June 2024Dikluwe talk contribs 44,174 bytes +28 Created page with "Se o comando {{incode|pip}} for usado sem a opção {{incode|--user}}, ele exigirá privilégios de superusuário (root) para instalar o pacote, mas isso não é necessário na maioria dos casos; Use permissões de root somente se tiver certeza de que o pacote não colidirá com os pacotes fornecidos pela distribuição."
  • curprev 18:2418:24, 19 June 2024Dikluwe talk contribs 44,146 bytes +8 Created page with "O Doxypypy pode ser instalado usando o {{incode|pip}}, o instalador do pacote Python."
  • curprev 18:2418:24, 19 June 2024Dikluwe talk contribs 44,138 bytes +27 Created page with "No exemplo anterior, o arquivo Python que é comentado em um estilo Doxygenestilo Doxygen mostra informações mais detalhadas e formatação para suas classes, funções e variáveis. A razão é que esse estilo permite que Doxygen extraia os comandos especiais que começam com {{incode|\}} ou {{incode|@}}, enquanto o estilo Pythonic não. Portanto, seria desejável converter..."
  • curprev 18:2018:20, 19 June 2024Dikluwe talk contribs 44,111 bytes +24 Created page with "A compilação da documentação procede da mesma forma que para fontes C++. Se ambos os arquivos Python {{incode|pyexample_a.py}} e {{incode|pyexample_b.py}}, com estilo de comentário distinto estiverem no mesmo diretório, ambos serão processados."
  • curprev 18:1918:19, 19 June 2024Dikluwe talk contribs 44,087 bytes 0 Created page with "A documentação deve mostrar informações semelhantes às seguintes e criar links apropriados para os módulos e classes individuais."
  • curprev 18:1918:19, 19 June 2024Dikluwe talk contribs 44,087 bytes −1 No edit summary
  • curprev 18:1818:18, 19 June 2024Dikluwe talk contribs 44,088 bytes +9 Created page with "No exemplo a seguir, os blocos de documentação começam com sinais de cerquilha dupla {{incode|##}}. Um aparece no início para explicar o conteúdo geral deste módulo (arquivo). Em seguida, há blocos antes das definições de função, classe e método de classe, e há um bloco após uma variável de classe. Dessa forma, o Doxygen extrairá a documentação, reconhecerá os comandos especiais {{incode|@package}}, {{incode|@param}} e {{incode|@var}}, e formatará o t..."
  • curprev 18:1618:16, 19 June 2024Dikluwe talk contribs 44,079 bytes +163 Created page with "O texto dentro de um bloco de documentação especial é analisado antes de ser gravado nos arquivos de saída HTML e LaTeX. Durante a análise, as seguintes etapas ocorrem: * A formatação Markdown é substituída por comandos HTML ou especiais correspondentes. * Os comandos especiais dentro da documentação são executados. Consulte a seção [http://www.doxygen.nl/manual/commands.html Comandos especiais] no manual para obter uma explicação de cada comando. * Se um..."
  • curprev 18:1218:12, 19 June 2024Dikluwe talk contribs 43,916 bytes +34 Created page with "Desde o Doxygen 1.8, a sintaxe Markdown é reconhecida em blocos de documentação. Markdown é uma linguagem de formatação minimalista inspirada em e-mail de texto simples que, semelhante à sintaxe wiki, pretende ser simples e legível sem exigir código complicado como o encontrado em HTML, LaTeX ou comandos do próprio Doxygen. Markdown ganhou popularidade com o software livre, especialmente em plataformas online como o Github, pois permite criar documentação sem..."
  • curprev 18:1018:10, 19 June 2024Dikluwe talk contribs 43,882 bytes +1 Created page with "A seguir estão as extensões Markdown. <pre> [TOC]"
  • curprev 18:0918:09, 19 June 2024Dikluwe talk contribs 43,881 bytes −1 Created page with "<div class="mw-collapsible-content"> A seguir está o Markdown padrão. {{Code|code= Here is text for one paragraph."
  • curprev 18:0818:08, 19 June 2024Dikluwe talk contribs 43,882 bytes +22 Created page with "O Doxygen suporta um conjunto padrão de instruções de Markdown, bem como algumas extensões, como o [https://github.github.com/github-flavored-markdown/ Github Markdown]. <div class="mw-collapsible mw-collapsed toccolours"> Alguns exemplos de formatação Markdown são apresentados a seguir."
  • curprev 17:4417:44, 19 June 2024Dikluwe talk contribs 43,860 bytes +24 Created page with "Doxygen funciona melhor para linguagens tipadas estaticamente como C++. No entanto, ele também pode criar [http://www.doxygen.nl/manual/docblocks.html#pythonblocks documentação para arquivos Python]."
  • curprev 17:4417:44, 19 June 2024Dikluwe talk contribs 43,836 bytes +56 Created page with "== Análise de blocos de documentação =="
  • curprev 17:4317:43, 19 June 2024Dikluwe talk contribs 43,780 bytes +46 Created page with "== Doxygen com código Python =="
  • curprev 17:4317:43, 19 June 2024Dikluwe talk contribs 43,734 bytes +16 Created page with "No exemplo a seguir, um docstring está no início para explicar o conteúdo geral deste módulo (arquivo). Em seguida, docstrings aparecem dentro das definições de método de função, classe e classe. Desta forma, Doxygen irá extrair os comentários e apresentá-los como estão, sem modificação."
  • curprev 17:4317:43, 19 June 2024Dikluwe talk contribs 43,718 bytes +61 Created page with "=== Primeiro estilo: documentação pythonica ==="
  • curprev 17:4317:43, 19 June 2024Dikluwe talk contribs 43,657 bytes +76 Created page with "=== Segundo estilo: bloco de documentação antes do código ==="
  • curprev 17:4217:42, 19 June 2024Dikluwe talk contribs 43,581 bytes +47 Created page with "=== Compilando a documentação ==="
  • curprev 17:4217:42, 19 June 2024Dikluwe talk contribs 43,534 bytes +71 Created page with "=== Convertendo o estilo Pythonic para o estilo Doxygen ==="
  • curprev 17:3717:37, 19 June 2024Dikluwe talk contribs 43,463 bytes +36 Created page with "O que isso faz é que os arquivos que correspondem ao padrão, todos os arquivos com uma extensão terminando em {{incode|.py}}, passarão pelo programa {{incode|doxypypy_filter}}. Toda vez que Doxygen encontrar esse arquivo na árvore de origem, o nome do arquivo será passado como o primeiro argumento para este programa."
  • curprev 17:3717:37, 19 June 2024Dikluwe talk contribs 43,427 bytes +6 Created page with "Para começar, não use o programa {{incode|doxypypy}} diretamente; Em vez disso, crie o arquivo de configuração com {{incode|doxygen -g}}, edite o {{incode|Doxyfile}}, criado e modifique a marca a seguir."
  • curprev 17:3617:36, 19 June 2024Dikluwe talk contribs 43,421 bytes +29 Created page with "No exemplo anterior, a conversão dos blocos de documentação era feita manualmente com apenas um arquivo de origem. Idealmente, queremos que essa conversão ocorra automaticamente, em tempo real, com qualquer número de arquivos Python. Para fazer isso, a configuração Doxygen deve ser editada de acordo."
  • curprev 17:3617:36, 19 June 2024Dikluwe talk contribs 43,392 bytes +69 Created page with "=== Convertendo o estilo de comentário em tempo real ==="
  • curprev 17:3517:35, 19 June 2024Dikluwe talk contribs 43,323 bytes +16 Created page with "Em sistemas Windows, um arquivo em lotes pode ser usado de maneira semelhante."
  • curprev 17:3517:35, 19 June 2024Dikluwe talk contribs 43,307 bytes +32 Created page with "{{Caption|Fluxo de trabalho geral para produzir documentação de código-fonte com Doxygen, quando os arquivos Python são filtrados para transformar os blocos de comentários.}}"
  • curprev 17:3517:35, 19 June 2024Dikluwe talk contribs 43,275 bytes +32 Created page with "Para verificar todos os arquivos dentro de uma árvore de código fonte use {{incode|find}}."
  • curprev 17:3417:34, 19 June 2024Dikluwe talk contribs 43,243 bytes +41 Created page with "Da mesma forma, um programa que verifica principalmente se os comentários estão em conformidade com o [https://www.python.org/dev/peps/pep-0257/ PEP257] é o [https://github.com/PyCQA/pydocstyle Pydocstyle]. Os códigos de erro podem ser consultados na [http://www.pydocstyle.org/en/4.0.0/error_codes.html documentação do Pydocstyle]."
  • curprev 17:3417:34, 19 June 2024Dikluwe talk contribs 43,202 bytes +35 Created page with "Se o projeto exigir, algumas verificações de código consideradas muito rígidas podem ser ignoradas. Os códigos de erro podem ser consultados na [https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes documentação do Pycodestyle]."
  • curprev 17:3317:33, 19 June 2024Dikluwe talk contribs 43,167 bytes +25 Created page with "Também é uma boa ideia verificar a qualidade do seu código Python com uma ferramenta como o [http://flake8.pycqa.org/en/latest/ flake8]([https://gitlab.com/pycqa/flake8 Gitlab]). Flake8 combina principalmente três ferramentas, [https://github.com/PyCQA/pyflakes Pyflakes], [https://github.com/PyCQA/pycodestyle Pycodestyle](anteriormente pep8) e o [https://github.com/PyCQA/mccabe verificador de complexidade McCabe], a fim de impor o estilo Python adequado."
  • curprev 17:3117:31, 19 June 2024Dikluwe talk contribs 43,142 bytes +27 Created page with "Sempre use aspas triplas para as cadeias de caracteres doc e certifique-se de que elas sigam imediatamente a declaração de classe ou função."
  • curprev 17:3117:31, 19 June 2024Dikluwe talk contribs 43,115 bytes +31 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> Os estilos de comentários a seguir não permitirão a análise das cadeias de caracteres doc pelo {{incode|doxypypy}}, portanto, eles devem ser evitados."
  • curprev 17:3017:30, 19 June 2024Dikluwe talk contribs 43,084 bytes +34 Created page with "Para usar a conversão automática de blocos de documentação é importante que os fontes originais do Python estejam corretamente escritos, seguindo as diretrizes pythonicas no [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8]e [https://www.python.org/dev/peps/pep-0257/ PEP257]. O código escrito de forma desleixada fará com que {{incode|doxypypy}} falhe ao processar o arquivo e, portanto, o Doxygen não conseguirá formatar a documentação corre..."
(newest | oldest) View (newer 50 | ) (20 | 50 | 100 | 250 | 500)