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

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

Devo apontar isso para ele ou estou sendo muito pedante ao perceber isso?

Código com erros ortográficos e gramaticais não é sustentável .

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

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

• A maioria das pessoas que faz gramática / ortografia o faz de maneira inconsistente, para introduzir muitos bugs com nomes incompatíveis. Isso é particularmente problemático em idiomas que não exigem que variáveis ​​sejam declaradas explicitamente antes do uso, porque você pode introduzir uma nova ortografia e seu código não será interrompido para informar que você errou.

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

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

Não os indique como defeitos em uma revisão formal de código. Em vez disso, marque uma lista e converse com ele PRIVAMENTE sobre eles. Seja o mais diplomático possível sobre isso, apenas "Ei, algo que notei, e já encontrei pessoas que realmente desprezam esse tipo de coisa, elas acham que isso faz o programador parecer descuidado e desleixado".

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

Para o exemplo que você deu, suspeito que tenha começado como UserHasPermission, e alguém lhe disse que a prática local era doesUserBlahBlah () em vez de UserBlahBlah (), e ele simplesmente ignorou a alteração gramatical.

Mude você mesmo.

Espero que você esteja em um ambiente em que o código "propriedade" não seja um problema. Se você tiver acesso ao projeto no controle de origem, entre e corrija você mesmo. Se você vir um colega de trabalho em particular cometendo o mesmo tipo de erros gramaticais ou de ortografia, convém apontar isso, 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, basta fazer o reparo em silêncio. Faço isso o tempo todo, se vejo um erro de digitação, especialmente em uma assinatura de método ou propriedade pública, apenas o corrigo. Ocasionalmente, eu não consigo nem resistir à tentação de corrigir um erro de digitação em um comentário, mas sou apenas eu :)

Sou um desenvolvedor cuja língua nativa não é o inglês, é realmente o holandês 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 script Perl simples pode ser facilmente escrito para percorrer todos os arquivos em uma pasta. Talvez até isso possa ser feito com sed? Eu não sei.

Portanto, eu certamente apontaria erros de gramática ou ortografia no código de outra pessoa, mas apenas se tiver certeza absoluta de que está correto o que estou dizendo.

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

Eu concordo com outras respostas dizendo que o código com erros gramaticais não é sustentá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 é seu idioma nativo. Se houver um erro gramatical em um código que você analisa, isso não significa que seu colega de trabalho cometeu esse erro. Talvez fosse apenas uma cópia e pasta de um site.
• Se o inglês não for um idioma nativo do seu colega de trabalho, pode ser uma boa ou uma péssima idéia contar a ele sobre esse erro. Sendo da França, sempre recebo 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 contar sobre os erros gramaticais que elas cometem.
• Como John R. Strohm disse, nunca faça isso publicamente. A maioria das pessoas ficará realmente irritada com isso.

Eu recomendaria o uso de um IDE com o corretor ortográfico incorporado. O IntelliJ Idea faz um trabalho maravilhoso para programas Java. Existem muitos erros de digitação embaraçosos, não apenas em nomes de funções, mas em, por exemplo, mensagens de exceção que o usuário vê. Um programa que produz mensagens cheias de erros de digitação não inspira muita confiança.

Eu faço isso apenas se

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

Apenas como uma observação lateral, se os nomes das suas funções forem longos o suficiente para ter gramática, provavelmente serão muito longos. No exemplo dado, eu chamaria a função userHasPermission e moveria a "gramática" para o seu código, algo como isto:

if userHasPermission() ...

Isso também acontece MUITO no meu projeto (sendo preenchido por pessoas que falam nativamente hebraico, russo ou árabe), mas mesmo em um nível mais alto - geralmente vejo código que usa alguma terminologia obscura que é o que o dicionário produziu como tradução para o dicionário. o que o autor tinha em mente, e não tem nada a ver com o que eles queriam dizer ...

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

No entanto, se estou comprometendo algum trabalho no mesmo arquivo que o código ou os comentários que foram escritos há muito tempo e eles têm erros de digitação, os corrigirei apenas porque não é muito trabalhoso.

A regra de ouro se aplica

Faça aos outros como gostaria que eles fizessem a você.

Quero que os outros estejam de olho nesse tipo de coisa, então ajudo os outros. Ser gentil e solidário pode ajudar muito a seu favor.

Como em 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é-confirmação. A automação o salvará de enormes quantidades de queixas, mesmo que você precise escrever sua própria ferramenta para esse fim.

Este é um pequeno erro no código, mas é um erro. Trate-o como qualquer outro erro que você encontrar. Minha política é sempre assumir 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 pedir ao colega para revisar essas correções. Deixe-os saber que você acha que eles são um bom codificador, mas que isso é algo que seria bom para melhorar. Eu acho que nunca faria um grande negócio sobre algo assim.

Desde que você não trate isso como um grande problema, deve ser fácil colocar esse colega de trabalho em uma posição em que ele possa melhorar sem colocar o ego em risco.

userPermission () talvez? -

O último que me deparei foi uma questão global de resultados de pesquisa que não estavam sendo destacados porque o nome da classe estava escrito como destaque. Bug muito obscuro para detectar.

É claro, mas não perca seu tempo procurando erros de ortografia. Use uma ferramenta para automatizar isso no seu IC. No .net o fxCop pode fazer isso ...

Depende em grande parte de quais são os erros, de quão comuns e ruins são, e se é realmente um erro de boa-fé ou simplesmente como você o expressaria.

Pessoalmente, não suporto quando um idiota arrasta uma revisão de código de 5 minutos por meia hora, porque ele quer que tudo seja renomeado como ele faria e todos os comentários reformulados apenas porque ele gosta de enfiar o remo. Uma linha de registro que diz "Carregando objetos de dados" não precisa ser alterado para "O componente do carregador de objetos de dados agora carregará os objetos de dados relevantes do componente de armazenamento de objetos de dados".

/ rant :)