Início / dba / Perguntas / 31785
Accepted
8kb
Asked: 2013-01-12 10:04:35 +0800 CST

Com o advento do controle de origem integrado, as alterações de procedimento armazenado ainda precisam de comentários?

  • 772

Antigamente, minha equipe tinha uma política de que qualquer modificação de procedimento armazenado exigia comentários em dois lugares:

  1. Parte superior do procedimento armazenado com um resumo geral das alterações feitas
  2. Comentários em cada linha onde a alteração foi feita

Normalmente era assim:

CREATE PROCEDURE usp_Test
/*****************************************************************
The purpose of this stored procedure is to get data.
Created by 8kb 2001-01-01
Modified: removed OR clauses from JOIN statement..8kb 2001-06-01
******************************************************************/
AS
BEGIN

SELECT * 
FROM t1
JOIN t2
ON t1.colA = t2.colA
-- Removed OR clause..8kb 2001-06-01
-- OR t1.ColB = t2.ColB

END

Mas agora, com o controle de código-fonte integrado, posso resumir as alterações no controle de código-fonte e usar a funcionalidade comparar/diferenciar para ver as diferenças entre as versões antiga e nova.

Ainda há valor em escrever comentários de alteração linha por linha em procedimentos armazenados que fazem parte do controle de origem integrado?

sql-server stored-procedures

2 respostas

  1. Best Answer

    Isso pode ser bom para uma alteração por módulo, mas imagine como seu código ficará após anos severos de desenvolvimento.

    Antes do controle de versão ser adotado universalmente, costumava haver módulos que eram 95% de log de histórico e apenas 5% de código real. Felizmente, o controle de versão automatizou esse inconveniente há muito tempo.

    Eu me livraria completamente dos logs de alterações nos comentários - somos muito mais produtivos usando ferramentas modernas. Além disso, o git e outras ferramentas de controle de versão permitem que você faça muito mais do que ver o log de alterações em um arquivo. Por exemplo, eles podem mostrar todos os outros arquivos alterados no mesmo commit. Além disso, eles fornecem informações precisas, embora não possamos confiar totalmente nos comentários.

    • 5

  2. Tê-lo no corpo também torna mais fácil para mim ver a lista de alterações em um só lugar, em vez de ter que olhar para o procedimento e selecionar o histórico do controle de origem. Portanto, tem valor IMHO, mas se vale a pena manutenção dupla no seu caso, não acho que essa seja uma pergunta que este site possa responder objetivamente.

    • 1

relate perguntas