Perguntas com a marcação «readability»

Suponha uma interface contendo estes métodos: Car find(long id); List<Car> find(String model); É melhor renomeá-los assim? Car findById(long id); List findByModel(String model); De fato, qualquer desenvolvedor que use essa API não precisará procurar na interface para conhecer os possíveis argumentos dos find()métodos iniciais . Portanto, minha pergunta é mais geral: …

14 design  naming  readability  method-overloading 

Recentemente, sugeri que um método de encadeamento fosse implementado para uma determinada classe em um determinado projeto, para que a legibilidade do código pudesse ser melhorada. Eu recebi uma resposta "interfaces fluentes não devem ser implementadas apenas por conveniência, mas por semântica" e tive minha sugestão abatida. Respondi que não …

14 architecture  coding-standards  readability  method-chaining 

Eu tenho um monte de classes que lidam com validação de valores. Por exemplo, uma RangeValidatorclasse verifica se um valor está dentro do intervalo especificado. Toda classe de validador contém dois métodos is_valid(value):, que retorna Trueou Falsedepende do valor, e ensure_valid(value)que verifica um valor especificado e não faz nada se …

13 unit-testing  exceptions  readability 

Quando você precisa repetir um leitor em que o número de itens a ler é desconhecido, e a única maneira de fazer isso é continuar lendo até chegar ao fim. Geralmente, é o lugar em que você precisa de um loop sem fim. Há sempre o trueque indica que deve …

13 c#  code-quality  readability 

Na maioria das linguagens de programação, as variáveis ​​não possuem caracteres de identificação como no PHP. No PHP, você deve prefixar uma variável com o $caractere. Exemplo; var $foo = "something"; echo $foo; Estou desenvolvendo uma nova linguagem de script para um aplicativo de negócios, e meus usuários de destino …

13 programming-languages  readability 

Eu sou novo no Clojure. Eu posso entender o código que escrevo, mas fica muito difícil entendê-lo mais tarde. Torna-se difícil combinar parênteses. Quais são as convenções genéricas a seguir em relação às convenções de nomenclatura e recuo em várias situações? Por exemplo, escrevi um exemplo de exemplo de desestruturação …

13 readability  clojure 

Eu estava apenas escrevendo uma declaração if com nomes de propriedades razoavelmente longos e viemos resolver esse problema. Digamos que tenhamos uma declaração if como esta: if(_someViewModelNameThatIsLong.AnotherPropertyINeedToCheck == someValue && !_someViewModelNameThatIsLong.ThisIsABooleanPropertyThatIsImportant) { //Do something } A segunda propriedade é do tipo booleano e não faz sentido ter a declaração como …

13 readability 

Fechado . Esta questão precisa ser mais focada . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela se concentre apenas em um problema editando esta postagem . Fechado há 2 anos . Estou curioso sobre isso porque, antes de aprender qualquer linguagem …

13 object-oriented  functional-programming  readability 

Meu entendimento é que as [Flag]enums geralmente são usadas para coisas que podem ser combinadas, onde os valores individuais não são mutuamente exclusivos . Por exemplo: [Flags] public enum SomeAttributes { Foo = 1 << 0, Bar = 1 << 1, Baz = 1 << 2, } Onde qualquer SomeAttributesvalor …

12 c#  .net  readability  enum 

Tento seguir o Princípio de responsabilidade única (SRP) e também omitir repetições de código. No entanto, geralmente existem lugares onde há repetições de código que nada mais são do que blocos de invocações de código que são resistentes a extraí-las para um método nomeado pelo menos significativo: DoAction1(); DoAction2(); if …

11 refactoring  readability  single-responsibility  code-reuse 

Recentemente, realizei uma refatoração de um projeto de tamanho médio em Java para voltar e adicionar testes de unidade. Quando percebi como era chato zombar de singletons e estáticos, finalmente "entendi" o que estava lendo sobre eles esse tempo todo. (Eu sou uma daquelas pessoas que precisa aprender com a …

11 coding-standards  readability  coding-style  static-methods 

O que seria considerado mais sustentável? if (a == b) c = true; else c = false; ou c = (a == b); Tentei procurar no código completo, mas não consigo encontrar uma resposta. Eu acho que o primeiro é mais legível (você pode literalmente ler em voz alta), o …

11 .net  code-quality  readability  maintainability  clean-code 

Estou trabalhando em um projeto no delphi e estou criando um instalador para o aplicativo, existem três partes principais. Instalação / desinstalação do PostgreSQL instalação / desinstalação do myapplication (a configuração do myapplication é criada usando o nsi). Criando tabelas no Postgres por meio de script (arquivos em lote). Tudo …

11 code-quality  readability  logging 

Suponho que essa pergunta será imediatamente sinalizada como subjetiva, mas qual você acha que é melhor: double volume(double pressure, double n_moles, double temperature) { return n_moles * BOLTZMANN_CONSTANT * temperature / pressure; } ou double volume(double P, double n, double T) { return n*R*T/P; } Em outras palavras, as funções …

11 math  coding-style  readability 

Qual destes é melhor para manutenção? if (byteArrayVariable != null) if (byteArrayVariable .Length != 0) //Do something with byteArrayVariable OU if ((byteArrayVariable != null) && (byteArrayVariable.Length != 0)) //Do something with byteArrayVariable Prefiro ler e escrever o segundo, mas lembro-me de ler em código completo que fazer coisas assim é …

11 programming-practices  coding-standards  maintenance  readability