<commit_before>---
layout: page
title: Documentation
category: basics
order: 10
lang: pt
---

Documentando código em Elixir.

## Sumário

- [Anotações](#anotacoes)
  - [Documentação em Linha](#documentacao-em-linha)
  - [Documentação de Módulos](#documentacao-de-modulos)
  - [Documentação de Funções](#documentacao-de-funcoes)
- [ExDoc](#exdoc)
  - [Instalando](#instalando)
  - [Gerando Documentação](#gerando-documentacao)
- [Boas Práticas](#boas-praticas)


## Anotações

Quanto nós comentamos e o que faz uma documentação de qualidade continua a ser uma questão controversa dentro do mundo da programação. No entanto, nós podemos concordar que odocumentação é importante para nós e para aqueles que trabalham com a nossa base de código.

Elixir trata de documentação como uma *cidadã de primeira classe*, oferecendo várias funções de acesso e geração de documentação para seus projetos. O núcleo do Elixir nos fornece muitos atributos diferentes para anotar uma base de código. Vejamos 3 maneiras:

  - `#` - Para documentação em linha.
  - `@moduledoc` - Para documentação em nível de módulo.<commit_msg>Updating title of documentation for Portuguese(Brazil)<commit_after>---
layout: page
title: Documentação
category: basics
order: 10
lang: pt
---

Documentando código em Elixir.

## Sumário

- [Anotações](#anotacoes)
  - [Documentação em Linha](#documentacao-em-linha)
  - [Documentação de Módulos](#documentacao-de-modulos)
  - [Documentação de Funções](#documentacao-de-funcoes)
- [ExDoc](#exdoc)
  - [Instalando](#instalando)
  - [Gerando Documentação](#gerando-documentacao)
- [Boas Práticas](#boas-praticas)


## Anotações

Quanto nós comentamos e o que faz uma documentação de qualidade continua a ser uma questão controversa dentro do mundo da programação. No entanto, nós podemos concordar que odocumentação é importante para nós e para aqueles que trabalham com a nossa base de código.

Elixir trata de documentação como uma *cidadã de primeira classe*, oferecendo várias funções de acesso e geração de documentação para seus projetos. O núcleo do Elixir nos fornece muitos atributos diferentes para anotar uma base de código. Vejamos 3 maneiras:

  - `#` - Para documentação em linha.
  - `@moduledoc` - Para documentação em nível de módulo.
{'fraction_non_alphanumeric': 0.08584070796460178, 'fraction_numerical': 0.002654867256637168, 'mean_word_length': 4.624378109452737, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6182178', 'n_tokens_mistral': 795, 'n_tokens_neox': 759, 'n_words': 260}