Encontrei um problema de esquina com a orientação geral de: substantivos para variáveis verbos para funções Especificamente, tenho um caso em que a palavra é ambígua - pode ser um verbo ou um substantivo. E, em alguns casos, quando estamos discutindo o aplicativo, ele será usado nos dois...
Eu sempre tenho problemas para descobrir se devo nomear um determinado método começando com getSomethingversus findSomething. O problema reside na criação de auxiliares para APIs mal projetadas. Isso geralmente ocorre ao obter dados de um objeto, o que requer o objeto como parâmetro. Aqui está um...
Frequentemente, vejo códigos que incluem erros ortográficos intencionais de palavras comuns que, para o bem ou para o mal, se tornaram palavras reservadas: klassou clazzpara aula :Class clazz = ThisClass.class kountpara contagem no SQL:count(*) AS kount Pessoalmente, acho que isso diminui a...
Freqüentemente, quando a sintaxe do idioma exigir que eu cite uma variável que nunca é usada, eu o nomeei _. Na minha opinião, isso reduz a desordem e me permite focar nas variáveis significativas no código. Acho que é discreto e produz um efeito "fora da vista, fora da mente". Um exemplo comum...
Os métodos booleanos sempre devem assumir a forma afirmativa, mesmo quando serão usados apenas na forma negativa? Digamos que eu queira verificar se existe uma entidade antes de criar uma, meu argumento é que a primeira forma abaixo é melhor que a segunda, se o método é ou não usado na forma...
É uma boa prática chamar a variável que um método retorna com um nome de variável result? Por exemplo: public Zorglub calculate() { Zorglub result = [...] [...] return result; } Ou devo nomeá-lo por seu tipo? public Zorglub calculate() { Zorglub zorglub = [...] [...] return...
Peguei o termo smurf nomeando daqui (número 21). Para salvar alguém que não conhece o problema, a nomeação Smurf é o ato de prefixar um monte de classes, variáveis etc. relacionadas com um prefixo comum, para que você acabe com "a SmurfAccountViewpassa a SmurfAccountDTOpara...
Não tenho certeza do que fazer com o seguinte: Nós coletamos dados de uma ferramenta externa dentro de nossa própria ferramenta. Estes dados são escritos em holandês. Estamos escrevendo nosso código Java em inglês. Devemos então traduzir esse holandês para o inglês ou mantê-lo em holandês? Por...
É suficiente distinguir métodos apenas pelo nome do argumento (não pelo tipo) ou é melhor nomeá-lo mais explicitamente? Por exemplo T Find<T>(int id)vs T FindById<T>(int id). Existe alguma boa razão para nomeá-lo de forma mais explícita (por exemplo, adicionar ById) vs manter apenas o...
Existem alguns nomes em que, se você os encontrar, sabe que já estragou algo. Por exemplo: XxxManager Isso é ruim porque uma classe deve descrever o que a classe faz. Se a palavra mais específica que você pode apresentar para o que a classe faz é "gerenciar", então a classe é muito...
Estou desenvolvendo um aplicativo Web típico com as seguintes camadas Camada da interface do usuário (MVC) Camada lógica de negócios (BAL) Camada de acesso a dados (DAL) Cada camada possui seu próprio objeto DTO, incluindo o BAL e o DAL. Minhas perguntas sobre isso são as seguintes O DTO...
Após a leitura Os nomes dos pacotes devem ser singular ou plural? Ocorreu-me que nunca vi um debate adequado cobrindo uma das minhas irritações: nomear implementações de interfaces. Vamos supor que você tenha uma interface Orderque deve ser implementada de várias maneiras, mas existe apenas a...
Se houver um método bool DoStuff() { try { // doing stuff... return true; } catch (SomeSpecificException ex) { return false; } } deveria ser chamado IsStuffDone()? Ambos os nomes podem ser mal interpretados pelo usuário: se o nome é DoStuff()por que ele retorna um valor booleano? Se o...
A maioria das linguagens de programação parece ter sido projetada para não permitir que se declare um identificador que começa com um número. Eu só estava curioso para saber o motivo. Já pesquisei na web, mas não consegui encontrar uma explicação
Estou solicitando as melhores práticas com esta pergunta. Isso é apenas um problema se a empresa cliente for estritamente nacional e tiver um idioma nativo que não seja o inglês, eu acho. Se o cliente tiver muitas expressões principalmente específicas do domínio (por exemplo, alemão), combinadas...
Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 4 anos . Recentemente me...
Eu tenho trabalhado com o objeto XMLHttpRequest em JavaScript recentemente e não pude deixar de notar que a caixa desse nome não faz sentido. Por que 'XML' está tudo em maiúsculas enquanto 'Http' não? Ambos são siglas! Certamente faria mais sentido que o nome fosse um dos
Todos conhecemos a convenção de nome de pacote Java de mudar o nome de domínio. Ou seja www.evilcorp.com, por convenção, optou por ter seus pacotes java com.evilcorp.stuff. Cada vez mais estou farto disso. Como programador comercial, encontro repetidamente que o nome do pacote de software é...
Pergunta: quais são as considerações práticas para a sintaxe classe os idvalores? Observe que não estou perguntando sobre a semântica , ou seja, as palavras reais que estão sendo usadas, como por exemplo, descritas neste post do blog . Já existem muitos recursos nesse lado das convenções de...
No artigo de Eric Lippert What's Up With notation húngaro? , ele afirma que o objetivo da notação húngara (o tipo bom) é estenda o conceito de "tipo" para incluir informações semânticas, além de informações de representação de armazenamento. Um exemplo simples seria o prefixo de uma variável...