Skip to content

Python: Documentar funções #12

Description

@levysantiago

Inserir na documentação de cada função:

  • Descrição da função.
  • Descrição dos parâmetros de entrada
  • Descrição dos tipos de retorno
  • Exemplo de uso

Exemplo no javascript:

/**
* @description Faz a soma de dois números.
* @param {number} a - O primeiro número da operação.
* @param {number} b - O segundo número da operação.
* @returns {int} result - O resultado da soma de dois números.
* @example
* const result = sum(10, 2);
*/
function sum(a, b) {
  return a + b;
}

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions