Executando verificação de segurança...
6

Concordo do POR QUE e nesses casos é realmente muito bom, alguns exemplos do código fonte do TabNews, onde numa migration sobre a criação da tabela users eu anotei o POR QUE de certos valores:

    // Why 254 in length? https://stackoverflow.com/a/1199238
    email: {
      type: 'varchar(254)',
      notNull: true,
      unique: true,
    },

    // Why 60 varchar? https://forums.phpfreaks.com/topic/293405-recommended-sql-datatype-for-bcrypt-hash/#comment-1500831
    password: {
      type: 'varchar(60)',
      notNull: true,
    },

...

    // Why "with timezone"? https://stackoverflow.com/a/20713587
    created_at: {
      type: 'timestamp with time zone',
      notNull: true,
      default: pgm.func("(now() at time zone 'utc')"),
    },

https://github.com/filipedeschamps/tabnews.com.br/blob/b620df28fe4ece27cc0b44bf62614d189071fc2b/infra/migrations/1632278997051_create-user-table.js#L17-L41

E pensando agora, o ideal seria apontar para uma issue permanente dentro do projeto com trechos do artigo original (mas ainda linkando para ele), para caso o link se tornar indisponível, você ainda ter a fração que importa sob seu controle.

Carregando publicação patrocinada...
1
1
1
1

Nesses casos imagina um select de 3mil linhas(agora com big data com ia tem muitos) que demorará muito tempo para descobrir que não era o que precisava mudar... era para o público jovem de faculdade particular classe alta(mais 300 especificacoes) que está entrando na faculdade depois de perder muito tempo lendo o código descobre que vc precisa do que está terminando a faculdade... rs(ninguém faz um título perfeito) Quero ver o tamanho do título definido as 300 especificações ou explicando claramente no select feito... ou integração com uma dll feita a 50 anos atrás com milhões(milhões) de linhas, milhares de funções... integra com ela... não precisa de documentação nem comentário.