Devo indicar erros relacionados a ortografia / gramática no código de alguém? [fechadas]

103
Ao revisar o código de um colega de trabalho, me deparei com alguns erros de ortografia em nomes de função e também erros gramaticais como 'doesUserHasPermission ()' em vez de 'doesUserHavePermission ()' em nomes de função e variável.

Devo mostrar isso a ele ou estou sendo muito pedante ao notar isso?

    
por Rahul 28.12.2010 / 05:55
fonte

16 respostas

202

O código com erros ortográficos e gramaticais é insustentável .

  • As pessoas não se lembrarão da gramática ruim, por isso tentarão chamar a função como ela deveria ter sido escrita, e é assim que os erros acontecem.

  • Você não pode buscar algo no código se não souber como está escrito.

  • A maioria das pessoas que fazem gramática / ortografia faz isso de forma inconsistente, então eles introduzem muitos erros com nomes incorretos. Isso é particularmente problemático em linguagens que não exigem que variáveis sejam explicitamente declaradas antes de serem usadas, porque você pode introduzir uma nova ortografia e seu código não será interrompido para que você saiba que você errou.

Corrigir esses problemas não é pedante, nem é necessário principalmente pela opinião dos outros sobre sua inteligência, alfabetização, etc. (embora isso seja um grande efeito colateral); trata-se de escrever qualidade, código de manutenção .

    
por 28.12.2010 / 06:31
fonte
37

Sim definitivamente. É mais fácil lembrar o nome se estiver gramaticalmente correto. Tentar lembrar os erros de gramática do nome e é outra coisa totalmente diferente.

    
por 28.12.2010 / 06:01
fonte
28

Não os aponte como defeitos em uma revisão de código formal. Em vez disso, marque uma lista e fale com ele / ela PRIVATAMENTE sobre eles. Seja o mais diplomático possível sobre isso, apenas "Hey, algo que eu notei, e eu encontrei pessoas que REALMENTE desprezam esse tipo de coisa, elas acham que isso faz o programador parecer descuidado e descuidado".

Se este é um código que um cliente vai ver, absolutamente DEVE ser corrigido. Goste ou não, reflete sobre a reputação da sua empresa.

Para o exemplo que você deu, eu suspeito que ele começou como UserHasPermission, e alguém lhe disse que a prática local era doesUserBlahBlah () ao invés de UserBlahBlah (), e ele simplesmente ignorou a mudança de gramática.

    
por 28.12.2010 / 06:02
fonte
10

Altere você mesmo.

Espero que você esteja em um ambiente em que a "propriedade" do código não seja um problema. Se você tiver acesso ao projeto no controle de origem, basta entrar e consertá-lo. Se você vir um colega de trabalho em particular fazendo o mesmo tipo de erros gramaticais ou de ortografia de forma consistente, convém indicá-lo, mas isso dependerá do seu relacionamento, se a pessoa é um falante nativo de inglês e sua receptividade geral. Mas se você decidir fazer isso ou não, simplesmente vá em silêncio e faça a correção. Eu faço isso o tempo todo, se eu vejo um erro de digitação, especialmente em uma assinatura de método ou propriedade pública, eu simplesmente corrijo. Ocasionalmente eu não posso nem resistir à tentação de corrigir um erro de digitação em um comentário, mas sou eu:)

    
por 28.12.2010 / 15:20
fonte
6

Sou um desenvolvedor cuja língua materna não é o inglês, é holandês na verdade, e não me importaria se alguém me apontasse um erro de gramática ou ortografia. Dessa forma, posso melhorar constantemente meu inglês. E certamente não é difícil corrigir todos os erros em todo o seu código-fonte. Um simples script Perl pode ser facilmente escrito para fazer um loop através de todos os arquivos em uma pasta. Talvez até isso possa ser feito com sed? Eu não sei.

Então, eu certamente apontaria erros de gramática ou ortografia no código de outra pessoa, mas somente se eu tivesse absoluta certeza se estava correto o que estou dizendo.

    
por 28.12.2010 / 20:14
fonte
6

Eu acho que vale a pena mencionar aqui que o cabeçalho do referenciador HTTP no protocolo HTTP foi grafado como "referenciador" (e nós temos que conviver com ele / aprendemos a viver com ele.):)

    
por 28.12.2010 / 15:29
fonte
4

Concordo com outras respostas dizendo que o código com erros gramaticais é insustentável.

Eu também quero adicionar algumas coisas:

  • O código é geralmente escrito por pessoas que não falam inglês muito bem e / ou o inglês não é o idioma nativo deles. Se houver um erro gramatical em um código analisado, isso não significa que seu colega de trabalho tenha cometido esse erro. Talvez tenha sido apenas um copiar e colar de um site.
  • Se o inglês não for uma língua nativa do seu colega de trabalho, pode ser uma boa ou uma péssima ideia informá-lo sobre esse erro. Sendo da França, sempre acolho comentários sobre os erros que cometi em inglês, porque é a única maneira de evitá-los no futuro; Por outro lado, conheço várias pessoas que se sentem realmente magoadas se você lhes conta erros gramaticais que elas cometem.
  • Como John R. Strohm disse, nunca faça isso publicamente. A maioria das pessoas ficará muito aborrecida com isso.
por 28.12.2010 / 06:56
fonte
2

Eu recomendaria usar um IDE com o corretor ortográfico integrado. IntelliJ Idea faz um trabalho maravilhoso para programas Java. Existem muitos tipos de erros embaraçosos captados, não apenas em nomes de funções, mas em, e. mensagens de exceção que o usuário consegue ver. Um programa que produz mensagens cheias de erros de digitação não inspira muita confiança.

    
por 28.12.2010 / 19:24
fonte
0

Eu só faço isso se

  • afeta o uso do programa
  • afeta a precisão do programa
  • Eu sei explicitamente que o autor quer ser corrigido.

Assim como uma nota secundária, se os nomes das suas funções forem longos o suficiente para ter gramática, provavelmente são muito longos. No exemplo dado, eu chamaria a função userHasPermission e moveria a "gramática" para o seu código, algo assim:

if userHasPermission() ...
    
por 28.12.2010 / 07:41
fonte
0

Isso também acontece MUITO no meu projeto (sendo povoado por pessoas de língua nativa hebraica, russa ou árabe), mas até mesmo em um nível mais alto - geralmente vejo código que usa uma terminologia obscura que é o que o dicionário produziu a tradução para o que o autor tinha em mente, e não tem nada a ver com o que eles significam ...

Pessoalmente, quando isso acontece com tanta frequência e por tantos membros da equipe que poderiam ter escrito o código antes mesmo de eu entrar no projeto, eu costumo ignorá-lo, porque isso não importa.

No entanto, se eu estou cometendo algum trabalho no mesmo arquivo como código ou comentários que foram escritos há muito tempo e eles têm erros de digitação no, eu vou corrigi-los só porque não é muito trabalho.

    
por 28.12.2010 / 10:50
fonte
0

Aplica-se a regra de ouro

Do unto others as you would have them do unto you.

Eu quero que os outros tenham minhas costas para esse tipo de coisa, então eu ajudo os outros. Ser gracioso e solidário pode ir muito longe a seu favor.

    
por 28.12.2010 / 17:15
fonte
0

Como acontece com muitas outras boas práticas de programação, a única maneira objetiva, não política e eficaz de implementar uma política sobre ortografia em programas é automatizá-la como parte do processo de pré-consolidação. A automação irá salvá-lo de enormes quantidades de queixas, mesmo que você tenha que escrever sua própria ferramenta para o propósito.

    
por 28.12.2010 / 20:24
fonte
0

Este é um pequeno erro no código, mas é um erro. Trate como qualquer outro erro que você encontrar. Minha política é sempre supor que meus colegas de trabalho são competentes e tratá-los dessa maneira até que provem o contrário.

Se for um único erro, posso corrigi-lo e fazer o check-in. Se for um padrão, posso começar a fazer com que esse colega de trabalho revise essas correções. Deixe-os saber que você acha que é um bom codificador, mas que isso é algo que seria bom melhorar. Eu não acho que eu faria algo importante sobre algo assim.

Desde que você não o trate como se fosse um grande problema, seria fácil colocar esse colega de trabalho em uma posição em que ele pudesse melhorar sem colocar o ego em risco.

    
por 28.12.2010 / 23:53
fonte
-1

userPermission () talvez? -

A última vez que me deparei foi uma questão global de resultados de pesquisa que não foram destacados porque o nome da classe foi escrito como hightlight. Erro muito obscuro para detectar.

    
por 28.12.2010 / 14:24
fonte
-1

Claro, mas não perca seu tempo verificando erros ortográficos. Use uma ferramenta para automatizar isso no seu IC. No .net fxCop pode fazer isso ...

    
por 28.12.2010 / 16:59
fonte
-2

Depende, em grande parte, de quais são os erros, quão comuns e quão ruins são, e se é realmente um erro genuíno ou simplesmente não é como você o pronuncia.

Eu pessoalmente não aguento quando algum idiota arrasta uma revisão de código de 5 minutos para meia hora, porque ele quer que tudo seja renomeado para como ele faria e todos os comentários foram reformulados só porque ele gosta de colocar o remo dentro Uma linha de log que diz "Carregando objetos de dados" não precisa ser alterada para "O componente carregador de objetos de dados carregará os objetos de dados relevantes do componente de armazenamento de objetos de dados".

/ rant:)

    
por 28.12.2010 / 19:21
fonte