como descobrir se erros de ortografia no código fonte são um problema sério ou não? [fechadas]

Acho uma quantidade muito preocupante de erros de ortografia que vejo todos os dias em nossa base de código, a partir da qual reproduzirei um exemplo muito curto, mas representativo:

ArgumnetCount
Timeount
Gor message from queue 

Infelizmente, isso não se limita a uma pessoa. Há muitos falantes de inglês não nativos em nossa equipe que contribuem para isso, mas também posso apontar alguns dos piores erros de ortografia para o arquiteto de software americano, nascido e criado.

Eles também podem ser encontrados em e-mails, apresentações, documentos, quaisquer informações escritas que temos em uma empresa de desenvolvimento de software.

Gostaria de saber como descobrir se é um problema sério ou não?

_{Eu sempre encontrei esses erros ortográficos com preocupação, mas minha política pessoal, oficial e oficial é que não somos pagos para escrever as coisas corretamente, somos pagos para fazer as coisas, por isso, dentro da empresa, nunca realmente critiquei ninguém por isso. Mas levantei esse problema com alguns de meus amigos mais próximos e nunca o resolvi para sempre.}

Erros de ortografia podem significar uma de duas coisas:

• A pessoa que os cria não é fluente em inglês e não dedica tempo para compensar usando as ferramentas apropriadas (dicionários, corretores ortográficos etc.)
• A pessoa que os cria é fluente em inglês, mas não se importa com a ortografia.

Um dos dois é um sinal bastante ruim, porque significa que a pessoa em questão não tem legibilidade, capacidade de manutenção e elegância no topo de sua lista de prioridades; se a causa é a falta de proficiência no idioma inglês, significa também que a pessoa não possui duas habilidades essenciais - comunicação escrita em inglês e um sentimento geral por idiomas (se você não pode expressar seus pensamentos claramente em inglês, é provável que você possa ' expresse-os bem em uma linguagem de programação).

Mas por que exatamente os erros ortográficos são ruins, sendo tudo o mais igual? Afinal, o código funciona e o compilador não se importa em como você nomeia seus identificadores, desde que eles não violem as regras de sintaxe. O motivo é que escrevemos código não apenas para computadores, mas também e acima de tudo, para humanos. Se não fosse esse o caso, ainda estaríamos usando assembly. O código-fonte é escrito uma vez, mas lido centenas de vezes durante seu ciclo de vida. Erros de ortografia dificultam a leitura e a compreensão do código-fonte - erros leves fazem o leitor tropeçar por uma fração de segundo, muitos deles podem causar atrasos consideráveis; erros muito ruins podem tornar o código fonte completamente ilegível. Há outro problema, que é que a maior parte do código que você escreve será referida por outro código, e esse código mais frequentemente do que não é escrito por outra pessoa. Se você digitar incorretamente seus identificadores, alguém terá que lembrar (ou procurar) não apenas qual é o nome, mas também como exatamente ele é digitado incorretamente. Isso leva tempo e interrompe o fluxo de programação; e como a maioria dos códigos é tocada mais de uma vez na manutenção, cada erro de ortografia causa várias interrupções.

Considere como o tempo do desenvolvedor é igual ao salário e às despesas, acho que deve ser fácil o suficiente fazer um caso disso; afinal, interromper o fluxo e voltar a ele pode levar até 15 minutos. Dessa forma, um grave erro ortográfico pode facilmente custar algumas centenas de dólares em desenvolvimento e manutenção adicional (mas são custos indiretos, não diretamente visíveis em estimativas e avaliações, portanto são frequentemente ignorados pela gerência).

Na verdade, duvido que "Timeount" seja uma questão de não ser um falante nativo. As pessoas fazem muitos erros de digitação em seu primeiro idioma. Eu não qualificaria esses exemplos específicos como "Engrish".

Dito isto, entendo que não se trata desses exemplos particulares. Eu concordo com você em princípio. Eu me deparei com problemas reais causados ​​por esse tipo de coisa ("se não houver uma coluna chamada anexos, crie anexos").

Ser programador é ser preciso e cuidadoso com erros de digitação, vírgulas, ponto e vírgula, pontos, o que é agnóstico na linguagem humana na maioria das vezes.

A primeira vez que você perde tempo pesquisando a Timeoutvariável apenas para descobrir que ela foi escrita Timeount, você saberá outro motivo pelo qual a ortografia é importante.

Se esse problema o incomoda, a maioria dos IDE agora permite comentários ortográficos nos comentários, para que os disléxicos pareçam pelo menos saber como se escreve. Com certeza me ajuda! Portanto, é uma "correção" trivial ter uma boa ortografia.

Os erros de ortografia nos nomes e métodos de classes públicas são simplesmente não profissionais. Eles custam tempo e dinheiro. Eles são dolorosos em linguagens estaticamente tipadas como Java, onde o IDE pode produzir um menu de nomes de classes e métodos. Eles são intoleráveis ​​em idiomas de tipo dinâmico.

Pior ainda são os erros de ortografia nos nomes de tabelas e de colunas do banco de dados.

Na minha experiência, a ortografia correta está apenas ligeiramente relacionada à proficiência em inglês do codificador. Vi falantes nativos de inglês produzirem código com ortografia e quebras de palavras essencialmente aleatórias e vi falantes de inglês não nativos que são cuidadosos ao produzir grafias corretas. Mas a ortografia correta está altamente relacionada à qualidade geral do código. Programadores capazes, independentemente de sua proficiência em inglês, se preocupam com a qualidade de seu trabalho e são cuidadosos com a nomeação.

No código fonte, apresentações e documentos internos etc. pequenos erros de digitação que não alteram o significado ou dificultam a compreensão não são um emblema. Basta corrigi-los na fonte, se você os achar irritantes.

Além disso, particularmente nos comentários, a substância é mais importante que a forma. Não se engrish aqui:

String s = "Wikipedia"; / * Atribui o valor "Wikipedia" à variável s. * /

O fato é que algumas pessoas são naturalmente escritores mais cuidadosos do que outras (isso se deve à educação, à atitude, à inteligência ou qualquer outra coisa que não seja relevante). Quanto gasta o esforço para corrigir essa é uma questão de valor comercial: você obtém mais valor corrigindo os erros de digitação do que se esforçando para corrigi-los? No caso de coisas internas, a resposta geralmente é não. Seus clientes não vão reclamar de erros de digitação nos comentários do código-fonte (a menos que você esteja fazendo código-fonte aberto).

Erros de digitação intencional e comentários inapropriados não são profissionais e devem ser evitados, mas o foco deve estar no que importa (por exemplo, gerar valor comercial, se você trabalha para negócios).

Material publicamente visível deve, é claro, ser cuidadosamente revisado.

O problema aqui não é o interesse em si, mas a falta de clareza de comentários. Inglês perfeito não é necessário, inglês claro é. É trivial executar algo no google para detectar os erros óbvios.

Por exemplo, não está claro à primeira vista se Gor message from queuesignifica "recebeu uma mensagem da fila" ou "mensagem GOR da fila". Você precisaria ler o código para entender o significado do comentário (derrotando assim o objeto do comentário).

Você deve solicitar a implementação de revisões de código em sua empresa. Você pode "criticar" as pessoas de maneira construtiva enquanto elas fazem o mesmo com você.

Deve ser óbvio que o compilador não se importa com erros ortográficos, desde que você esteja usando a mesma ortografia, por exemplo, ao fazer referência a uma variável. A questão então é se os erros de ortografia têm um impacto negativo na capacidade dos membros da equipe de manter o código.

A única maneira de ver isso seria conversar com as pessoas que fazem a manutenção, e você poderia começar perguntando se alguém teve mais dificuldade em seguir o código que continha erros de ortografia.

Acho que não há como remover completamente a subjetividade desse problema, mas para reduzi-lo, você pode (manualmente ou por meio de um script) digitalizar a fonte para obter um número estimado de erros de ortografia para um módulo de código específico e verificar se há manutenção nos módulos com um número maior de erros de ortografia, demorou mais tempo, em média, do que nos módulos com menos erros de ortografia.

É claro que nem todos os módulos são iguais, portanto, você pode ponderar seus resultados com várias métricas, como a complexidade ciclomática do módulo.

Na minha experiência, tais erros ortográficos básicos são preocupantes e podem ser sintomáticos de problemas mais profundos. Todos os projetos nos quais trabalhei com erros "triviais" como esse tiveram problemas reais de design que, de alguma forma, passaram pelo processo de revisão apenas para surgir durante o desenvolvimento, o que não é quando você deseja descobrir a funcionalidade crítica que realmente precisa não está lá.

Eu verificaria as especificações do sistema (se elas existirem) e examinaria o design geral; Eu não ficaria surpreso se você encontrasse alguns buracos.

Na verdade, são dois problemas separados, mas relacionados. Depende de onde estão os erros de ortografia:

1) No código fonte. Se você tiver um identificador como ArgumnetCountesse, poderá criar problemas reais quando alguém aparecer e usar a ortografia correta . Portanto, você deve corrigir esses erros sempre que possível. Se você precisar preservar a compatibilidade da API com versões anteriores, poderá fazer algo como:

/**
 * @deprecated - use setArgumentCount()
 */
public void setArgumnetCount(int c) {
    setArgumentCount(c);
}

2) Em texto legível por humanos (e-mails, documentação, comentários de código). Escrever corretamente é importante, mas eu diria que é uma prioridade mais baixa, pois o software de análise dentro da sua cabeça é muito mais tolerante. Se você vir um texto com alguns erros, que ainda é legível, não se preocupe: o problema não é seu. Mas se alguém lhe enviar alguma bobagem associativa gratuita e esperar que você use essa bobagem como modelo para um aplicativo da web para múltiplos usuários, envie uma nota educada ao autor solicitando esclarecimentos (algo como: "Seu idiota analfabeto, como você espera que eu entenda essa merda? ")

Inglês escrito corretamente é uma obrigação no código. Eu também tenho uma grande base de código cheia de bobagens e é um pesadelo para manter.

Não deixe que isso saia do controle. Tente educar a todos que os mantenedores de código não são leitores de mentes.

Bem, este é um problema cultural multifacetado.

Falando da perspectiva alemã: percebemos como nossa própria língua é cada vez mais influenciada pelos termos em inglês. Isso vai tão longe quanto as empresas nacionais que têm slogans ou publicidade em inglês. Enquanto isso, algumas pessoas, especialmente em cargos de gerência, aparentemente são incapazes de pronunciar apenas uma frase em alemão comum. O discurso deles é cheio de palavrões e gírias incompreensíveis. Dizemos que essas pessoas estão falando "denglish".

Dado esse estado de coisas e o inglês ser a "língua franca", especialmente nos negócios de software, é inevitável que o próprio inglês seja influenciado pelo grande número de falantes não nativos. Mas, para falantes nativos de inglês, isso ainda é melhor do que ter que dizer, por exemplo, chinês para participar do setor de SW.

É cor ou cor? Qual versão do inglês você acha correta? Um homem escreve a ortografia correta e outro homem desculpa para iniciar uma guerra vencível.

Se você quer começar uma guerra, escolha suas batalhas com cuidado e vença-as. No seu caso, não se preocupe com comentários, se preocupe menos com internos e concentre-se (quase) exclusivamente nas APIs

Eu tenho uma máxima: código arrumado não significa necessariamente uma mente arrumada, mas o inverso é certamente verdadeiro: código desarrumado, mente desarrumada.

Um programador que não toma tempo para nomear as variáveis ​​corretamente e escrever os comentários corretamente quase certamente não está gastando tempo para fazer outra coisa corretamente. Se o programador é um falante nativo de inglês não é um problema real, já que problemas com o inglês podem (e devem) ser tratados durante a revisão por pares.

Sim, é um problema sério para o produto, para a equipe e para os indivíduos.

• Para o produto: a correção pode apresentar defeitos detectados apenas pelos clientes
• Para a equipe: a equipe gasta tempo corrigindo códigos incorretos em vez de criar valor
• Para os indivíduos: a ortografia ruim faz com que você pareça estúpido e reduz sua posição profissional entre os colegas.