Charles Lee

12/01/2025 Código Limpo / Log / Comentários / Passeio

  • Idioma de escrita: Coreana
  • País de referência: Todos os paísescountry-flag
  • TI

Criado: 2025-01-13

Criado: 2025-01-13 00:16

Vejamos o mundo.

Economia

Passeios

  • Galeria subterrânea da estação de Bucheon (primeira visita por causa de um conhecido): Lotado de pessoas. Difícil ficar parado. Muito grande, preços baixos e bom.
12/01/2025 Código Limpo / Log / Comentários / Passeio

TI

Estudo de inglês

  • Preparei o inglês antecipadamente e, usando o ChatGPT, fiz perguntas para obter as respostas que eu queria. Parece que o trabalho de professor de inglês será substituído e é muito útil para minha escrita. Estou resumindo artigos que leio todos os dias e consultando o ChatGPT para verificar frases melhores.
    • Corrija os erros no inglês a seguir e destaque as partes incorretas. Responda no formato markdown. Por favor, remova as linhas em branco.

Código

  • Qual é a melhor maneira de usar logs? Pesquisei e escrevi sobre registradores para usar em Python e Bash. Em Python, existe um módulo padrão embutido chamado logger, mas eu achei melhor usar o loguru, que tem mais recursos, e adicionei os resultados dos testes, incluindo o nome da classe. Para o Bash, também achei necessário distinguir entre info/warn/critical e abordei os projetos open source relacionados: https://github.com/cheoljoo/publish/blob/main/log.md
  • Os comentários devem ser escritos de forma a tornar o código o mais legível possível, como descrito no código limpo, de forma que os comentários não sejam necessários. No entanto, em Python, é uma boa ideia adicionar comentários no nível de classe/função no formato de docstring, pois é possível gerar documentação automaticamente. No caso do Bash, se você escrever como uma docstring, adicionando apenas # na frente, também será possível criar uma ferramenta para gerar automaticamente a documentação. : https://github.com/cheoljoo/publish/blob/main/comments.md
    • No Bash, é preciso ter cuidado especial porque todas as variáveis são variáveis globais, então, se você descrever isso bem nos comentários, poderá criar um mapa usando isso para ver de um relance onde as variáveis são usadas. (Por favor, sugira se você tiver uma boa ideia.)

Comentários0