ti-enxame.com

O que você nomeia funções / variáveis ​​/ etc quando não consegue pensar em um bom nome?

Quando você está definindo uma função/variável/etc e não tem certeza do nome, qual é o nome? Como você cria um nome?

Se você usar um nome temporário como um cartão de lugar até que você dê o nome verdadeiro, qual nome temporário você usa ?


atualizar

Eu tenho usado coisas como WILL_NAME_LATER, NEEDS_NAME ou TO_BE_NAMED. Eu esperava que houvesse uma convenção adotada, na verdade eu esperava que, se eu usasse essa convenção, meu IDE realçaria o nome até que eu o alterasse.

13
JD Isaacks

É quase impossível não conseguir pensar em um nome para um artefato que você deseja criar. Você pode não gostar do nome que aparece, porque não é conciso ou sexy, mas se você pensar demais, acabará com um artefato com um nome ruim.

Digamos que você tenha algo que o ajude a construir objetos, mas você não sabe que isso geralmente é chamado de fábrica. Basta chamá-lo de ObjectCreator. Parece obtuso, mas pelo menos é claro.

Digamos que você tenha um dicionário que converta nomes de host em endereços IP. Vá em frente e chame-o HostnamesToIpAddresses. Claro que é longo, mas diz exatamente o que faz.

A incapacidade de criar um nome para algo significa que você não sabe o que está fazendo, o que também significa que você tem um problema maior diante de você.

29
Mark Canlas

Eu sempre tento dar minhas variáveis ​​e funções grandes nomes.

Se não consigo pensar em um grande nome, aceitarei um bom nome.

Se não conseguir criar um bom nome, usarei um nome correto.

Nunca, em 15 anos de programação profissional, fui incapaz de criar um nome decente.

34
Portman

Se você não consegue pensar em um bom nome em uma variável ou função, você não entende o que está fazendo ou tem um design ruim. De qualquer forma, digitar um nome arbitrário como "x" (a menos que você esteja lidando com coordenadas) não resolverá seu dilema; só piorará e a dor continuará maior.

12
gablin

Esta pergunta e especialmente suas respostas me assustam. Alguém precisará manter o código no qual você acabou de nomear uma variável "Cup", você sabe. Se você não tiver sorte, alguém será você!

Você tem uma variável. É uma coisa Representa uma coisa, de qualquer maneira. E as coisas têm nomes. É assim que você sabe que são coisas! Você está realmente me dizendo que precisa nomear uma coisa após outra, porque não pode inventar o nome da coisa real?

Iteradores devem ser chamados i. Os iteradores aninhados provavelmente são um erro, mas se você precisar deles, faça o seu caminho através do resto das vogais, em ordem (a, e, o, u e deus me ajude, sim, às vezes y).

Além disso, basta chamar a coisa do que é e fazer com ela!

5
Dan Ray

Se não conseguir criar um grande nome imediatamente, uso temporariamente um nome "ok" e continuo codificando. Pelo menos será algo que adequadamente descreve o item, mesmo que não seja perfeito. Quase sempre, quando terminar de escrever o primeiro rascunho desse pedaço de código em particular, um nome mais perfeito terá me ocorrido. Através do processo de codificação, minhas intenções com essa variável específica se tornam mais claras. (Por outro lado, às vezes me ocorre que a variável to foi mal concebida para começar e a apago em favor de outra coisa.)

4
Nick Spreitzer

Eu nomeio o que acho que a função deve fazer - algo que mais ou menos transmite a intenção. Depois que o corpo da função é escrito, acho óbvio como chamá-lo, e volto e o renomeio, se necessário.

3
Adam Lear

foo e barra . Como ainda não há significado por trás da nomeação de funções/variáveis, uso alguma combinação de Foo e/ou Bar com o que estou tentando definir.

Isso facilita a pesquisa/localização mais tarde, quando eu entendo melhor como deve ser chamado.

Veja também Foobar na wikipedia .

Os termos foobar, foo, bar e baz às vezes são usados ​​como nomes de espaço reservado (também chamados de variáveis ​​metassintáticas) na programação de computadores ou na documentação relacionada ao computador. Eles foram usados ​​para nomear entidades como variáveis, funções e comandos cujo objetivo não é importante e serve apenas para demonstrar um conceito. As próprias palavras não têm significado nesse uso. Às vezes, Foobar é usado sozinho; foo, bar e baz às vezes são usados ​​nessa ordem, quando várias entidades são necessárias.

2
spong

O que eu chamo de variáveis ​​difíceis de nomear, eu faço um //TODO find a better name comente para que eu possa voltar mais tarde para renomeá-lo

Normalmente, quando começo a usar a variável/função/classe, encontro um nome melhor para elas.

1
user1041

Prefixe sua função com algo e dê o nome de melhor foto por enquanto. Por exemplo, uma função que salva todos os produtos para o usuário selecionado no banco de dados pode ser RENAME_SaveAllProductsForTheSelectedUserToTheDatabase ()

1
HardCode

Às vezes eu uso zzzz temporariamente.

Uma boa regra para ajudá-lo é esta:

  • Ele retorna um valor booleano e não tem efeitos colaterais: use um adjetivo (comece com é, era), mas nunca no futuro.
  • Ele retorna um tipo diferente e não tem efeitos colaterais: Em seguida, use um substantivo.
  • Não retorna nada, mas faz algo: Em seguida, use um verbo.
  • É uma classe: Então use um substantivo.
0
ctrl-alt-delor

Quase nunca tenho problemas em encontrar nomes bons e descritivos ... mas, às vezes, a nomeação se torna bastante redundante, pois os nomes de classe e variável são muito semelhantes. WebClient webclient = novo Webclient (uri); ...e similar.

0
Zaz

É melhor colocar um bom nome em breve enquanto você tiver o código em mente, do que esperar até mais tarde, quando desejar que o tenha nomeado bem!

0
Jon Onstott