Ir ao conteúdo
  • Cadastre-se
icarodantas123

RESOLVIDO Dicas boas pra nomenclatura de variáveis?

Recommended Posts

Opa! Ultimamente eu estive me preocupando com a organização de meus códigos em C# e vi que não estou mantendo padrões nos nomes delas...

Bem, eu gostaria de saber se vocês sabem algum canto com dicas sobre isso, por exemplo, como escolher um bom nome pra uma função? Por exemplo, eu fiz uma função que era pra pegar uma palavra entre duas tags, eu chamava de strPick, ou será que deveria ser StrPick? Ou pickStr? PickStr?

Compartilhar este post


Link para o post
Compartilhar em outros sites

A pergunta é bom, e existem normas determinadas por grupos de programadores, ou sociedade. Não existe nada de meu conhecimento que seja oficial, entretanto existe um padrão ou regra que inviabiliza variáveis que comece com números, isto é proibido.  

No seu exemplo poderia escrever como: strpick() ou str_pick() ou ainda strPick() em ainda assim: fnStrPick()

fn - sigla para function. Como já disse não reconheço padrões para este tipo de elemento do código, em geral você pode copiar o estilo de um programador famoso.

:)

Compartilhar este post


Link para o post
Compartilhar em outros sites

Obrigado Mauro! Bem, enquanto eu fiz a postagem fui direto ao google pesquisar sobre isso, o problema é que eu não estava sabendo pesquisar mas acabei achando um artigo muito *****! Aqui ele se quiser ver depois :D

Compartilhar este post


Link para o post
Compartilhar em outros sites

Em realidade não existe norma alguma, existe umas regras que estipula a linguagem, porém as tais normas depende mais do equipe de trabalho. Por exemplo para Classes e estruturas você pode usar a primeira letra em maiúsculas para o tipo e todas minúsculas para o identificador. Por quê? Simples...! pense que você declare uma estrutura tipo:
struct Lista{...};

Dai você vai criar um objeto da lista, porém pense que que se você tivesse declarado essa estrutura tal como struct lista{...}; você não poderia fazer isso ao criar um objeto do tipo lista:
struct lista lista; //Errado

Nesse caso você pode apreciar que não faz sentido algum tanto lista do tipo como lista do identificador chamar-se iguais "lista lista", para o programa ja existe um tipo chamado "lista" que é a struct, e você quer declarar outro chamado igual. porém as vezes é interessante chamar a variável igualmente como o mesmo tipo mas com tipos de letras diferentes
struct Lista{...};

struct Lista lista;

Agora sim faz mais sentido não?

E si fazemos um typedef? Então recomendaria algo como:
struct _Lista{...};
typedef struct _Lista Lista;

Agora podemos criar a variável assim:
Lista lista[100];

Ótimo não?
Pense em uma agenda... nesse caso faz mais sentido ainda.
struct _Contatos{
char nome[100];
int telefone;
};
typedef struct _Contatos Contatos;
Contatos lista[100];

Nesse caso você teria uma lista de 100 contatos no qual você pode fazer:
lista[1].telefone = 999999999;

Ou se preferir:
Contatos contato[100];
contato[1].telefone = 999999999;

Esse ultimo faz mais sentido ainda não? queremos o telefone do contato 23 fazemos
printf("%d", contato[23].telefone);

Então com tudo isso vimos que "talvez" seja melhor chamar as estruturas com um '_' adiante do seu nome, por que logo depois podemos fazer um typedef(definição de um novo tipo de dados), que no caso seria o mesmo tipo mas sem o '_' adiante, permitindo declarar coisas como Agenda contato[10] ou Agenda auxiliar por exemplo.

Sobre espaços, nomes, etc, eu não me preocuparia muito, quando você for trabalhar em equipe certamente a equipe vai adotar umas certas "normas" que permita "todo" o grupo trabalhar mais ou menos de forma clara para todos. Certamente todos iriam se por de acordo se usar diasMes ou dias_mes, se usar struct Lista ou struct _lista, ou usar inclusive coisas diferentes.

Agora mesmo meu conselho é adotar a forma mais cômoda que você achar melhor, quando for trabalhar em grupo certamente terão reuniões para estipular o "tipado" do código que todos usarão.

Provavelmente você mesmo se dará conta da melhor forma de fazer isso com o tempo, ao ler código de outros usuários.

Compartilhar este post


Link para o post
Compartilhar em outros sites
Em 18/09/2016 às 11:09, icarodantas123 disse:

Obrigado Mauro! Bem, enquanto eu fiz a postagem fui direto ao google pesquisar sobre isso, o problema é que eu não estava sabendo pesquisar mas acabei achando um artigo muito *****! Aqui ele se quiser ver depois :D

Não chega a ser um padrão oficial, contudo como o próprio autor diz "Depois de estudos e da experiência adquirida nos projetos" ele chegou a este que pode vir a ser um exemplo a seguir.

Compartilhar este post


Link para o post
Compartilhar em outros sites

Crie uma conta ou entre para comentar

Você precisar ser um membro para fazer um comentário

Criar uma conta

Crie uma nova conta em nossa comunidade. É fácil!

Crie uma nova conta

Entrar

Já tem uma conta? Faça o login.

Entrar agora





Sobre o Clube do Hardware

No ar desde 1996, o Clube do Hardware é uma das maiores, mais antigas e mais respeitadas publicações sobre tecnologia do Brasil. Leia mais

Direitos autorais

Não permitimos a cópia ou reprodução do conteúdo do nosso site, fórum, newsletters e redes sociais, mesmo citando-se a fonte. Leia mais

×