Quais são as convenções de nomenclatura mais comuns em C?

Quais são as convenções de nomenclatura comumente usadas em C? Eu sei que existem pelo menos dois:

1. GNU / linux / K&R com lower_case_functions
2. ? nome? com funções UpperCaseFoo

Eu estou falando sobre C apenas aqui. A maioria de nossos projetos são pequenos sistemas embarcados nos quais usamos C.

Aqui está o que estou planejando usar para o meu próximo projeto:

Convenção de nomenclatura C

Struct              TitleCase
Struct Members      lower_case or lowerCase

Enum                ETitleCase
Enum Members        ALL_CAPS or lowerCase

Public functions    pfx_TitleCase (pfx = two or three letter module prefix)
Private functions   TitleCase
Trivial variables   i,x,n,f etc...
Local variables     lower_case or lowerCase
Global variables    g_lowerCase or g_lower_case (searchable by g_ prefix)

A coisa mais importante aqui é consistência. Dito isto, sigo a convenção de codificação GTK +, que pode ser resumida da seguinte forma:

1. Todas as macros e constantes em maiúsculas: MAX_BUFFER_SIZE, TRACKING_ID_PREFIX.
2. Nomes de estruturas e typedef em camelcase: GtkWidget, TrackingOrder.
3. Funções que operam em estruturas: estilo C clássico: gtk_widget_show(), tracking_order_process().
4. Ponteiros: nada extravagante aqui: GtkWidget *foo, TrackingOrder *bar.
5. Variáveis ​​globais: apenas não use variáveis ​​globais. Eles são maus.
6. Funções que estão lá, mas não devem ser chamadas diretamente, ou têm usos obscuros, ou qualquer outra coisa: um ou mais sublinhados no início: _refrobnicate_data_tables(), _destroy_cache().

"Ponteiros estruturais" não são entidades que precisam de uma cláusula de convenção de nomenclatura para cobri-los. Eles são apenas struct WhatEver *. NÃO esconda o fato de que há um ponteiro envolvido com um typedef inteligente e "óbvio". Não serve para nada, é mais demorado para digitar e destrói o equilíbrio entre declaração e acesso.

Bem, em primeiro lugar, C não possui funções públicas / privadas / virtuais. Isso é C ++ e tem convenções diferentes. Em C, normalmente você tem:

• Constantes em ALL_CAPS
• Sublinhados para delimitar palavras em estruturas ou nomes de funções, quase nunca você vê casos de camelo em C;
• structs, typedefs, uniões, membros (de uniões e estruturas) e valores de enum geralmente estão em letras minúsculas (na minha experiência), em vez da convenção C ++ / Java / C # / etc de tornar a primeira letra uma maiúscula, mas acho que é possível em C também.

C ++ é mais complexo. Eu vi uma mistura real aqui. Camel case para nomes de classe ou minúsculas + sublinhados (case camel é mais comum na minha experiência). As estruturas são usadas raramente (e geralmente porque uma biblioteca as exige, caso contrário, você usaria classes).

Você sabe, eu gosto de mantê-lo simples, mas claro ... Então, aqui está o que eu uso, em C:

• Variáveis ​​Triviais : i,n,c(. Apenas uma carta Se uma letra que não está claro, em seguida, torná-lo uma variável local), etc ...
• Variáveis ​​locais :lowerCamelCase
• Variáveis ​​globais :g_lowerCamelCase
• Variáveis ​​Const :ALL_CAPS
• Variáveis ​​de ponteiro : adicione p_a ao prefixo. Para variáveis ​​globais, seria gp_var, para variáveis ​​locais p_var, para variáveis ​​const p_VAR. Se ponteiros distantes forem usados, use umfp_ vez de p_.
• Estruturas : ModuleCamelCase(Módulo = nome completo do módulo ou abreviação de 2-3 letras, mas ainda emCamelCase .)
• Variáveis ​​de membro de estrutura :lowerCamelCase
• Enums :ModuleCamelCase
• Valores Enum :ALL_CAPS
• Funções Públicas :ModuleCamelCase
• Funções Privadas :CamelCase
• Macros :CamelCase

Digitei minhas estruturas, mas usei o mesmo nome para a tag e para o typedef. A tag não deve ser usada com frequência. Em vez disso, é preferível usar o typedef. Também encaminhar declarar o typedef no cabeçalho do módulo público para encapsulamento e para que eu possa usar o nome typedef na definição.

struct Exemplo completo :

typdef struct TheName TheName;
struct TheName{
    int var;
    TheName *p_link;
};

Codificação em C #, java, C, C ++ e C objetivo ao mesmo tempo, adotei uma convenção de nomenclatura muito simples e clara para simplificar minha vida.

Em primeiro lugar, ele conta com o poder dos IDEs modernos (como eclipse, Xcode ...), com a possibilidade de obter informações rápidas ao passar o mouse ou clicar com a tecla Ctrl ... Aceitando isso, suprimi o uso de qualquer prefixo, sufixo e outros marcadores que são simplesmente fornecidos pelo IDE.

Então, a convenção:

• Qualquer nome DEVE ser uma frase legível explicando o que você tem. Como "esta é a minha convenção".
• Em seguida, 4 métodos para obter uma convenção de uma frase:
  1. THIS_IS_MY_CONVENTION para macros, membros da enumeração
  2. ThisIsMyConvention para nome do arquivo, nome do objeto (classe, estrutura, enum, união ...), nome da função, nome do método, typedef
  3. this_is_my_convention variáveis ​​globais e locais,
     parâmetros, elementos struct e union
  4. thisismyconvention [opcional] variáveis ​​muito locais e temporárias (como um índice de loop for ())

E é isso.

Dá

class MyClass {
    enum TheEnumeration {
        FIRST_ELEMENT,
        SECOND_ELEMENT,
    }

    int class_variable;

    int MyMethod(int first_param, int second_parameter) {
        int local_variable;
        TheEnumeration local_enum;
        for(int myindex=0, myindex<class_variable, myindex++) {
             localEnum = FIRST_ELEMENT;
        }
    }
}

Eu recomendaria não misturar camel case e sublinhar a separação (como você propôs para os membros struct). Isso é confuso. Você pensaria, ei, eu tenho, get_lengthentão eu provavelmente deveria ter make_subsete então você descobrirá que é realmente makeSubset. Use o princípio de menor espanto e seja consistente.

Acho CamelCase útil para digitar nomes, como estruturas, typedefs e enumerações. Isso é tudo, no entanto. Para todo o resto (nomes de funções, nomes de membros de estrutura, etc.) eu uso underscore_separation.

Aqui está um (aparentemente) incomum, que eu achei útil: nome do módulo no CamelCase, depois um sublinhado, depois o nome da função ou do escopo do arquivo no CamelCase. Então, por exemplo:

Bluetooth_Init()
CommsHub_Update()
Serial_TxBuffer[]

Estou confuso com uma coisa: você está planejando criar uma nova convenção de nomenclatura para um novo projeto. Geralmente, você deve ter uma convenção de nomes que abranja toda a empresa ou equipe. Se você já possui projetos com qualquer forma de convenção de nomenclatura, não deve alterar a convenção para um novo projeto. Se a convenção acima é apenas uma codificação de suas práticas existentes, você é de ouro. Quanto mais difere da existente fato de fato padrões mais difícil será obter participação no novo padrão.

Sobre a única sugestão que gostaria de acrescentar é que gosto de _t no final dos tipos no estilo de uint32_t e size_t. É muito c-ish para mim, embora alguns possam reclamar, é apenas um húngaro "reverso".

Você também deve pensar na ordem das palavras para completar automaticamente o nome .

Uma boa prática: nome da biblioteca + nome do módulo + ação + assunto

Se uma peça não for relevante, basta ignorá-la, mas pelo menos um nome de módulo e uma ação sempre devem ser apresentados.

Exemplos:

• nome da função: os_task_set_prio, list_get_size,avg_get
• define (aqui geralmente nenhuma parte de ação ):OS_TASK_PRIO_MAX

Pode haver muitos, principalmente IDEs, ditando algumas tendências e as convenções de C ++ também estão avançando. Para C geralmente:

• UNDERSCORED_UPPER_CASE (definições de macro, constantes, membros da enumeração)
• underscored_lower_case (variáveis, funções)
• CamelCase (tipos personalizados: estruturas, enumerações, uniões)
• uncappedCamelCase (estilo Java oppa)
• UnderScored_CamelCase (variáveis, funções sob o tipo de namespaces)

A notação húngara para globais é boa, mas não para tipos. E mesmo para nomes triviais, use pelo menos dois caracteres.

Eu acho que isso pode ajudar para iniciantes: Convenção de nomenclatura de variáveis ​​em c

1. Você precisa usar Caractere alfabético (az, AZ), Dígito (0-9) e Sob Pontuação (_). Não é permitido usar caracteres especiais como:%, $, #, @ etc. Portanto, você pode usar o user_name como variável, mas não pode usar o user & name .
2. Não é possível usar espaço em branco entre as palavras. Portanto, você pode usar user_name ou nome de usuário ou nome de usuário como variável, mas não pode usar nome de usuário .
3. Não é possível começar a nomear com dígito. Portanto, você pode usar user1 ou user2 como variável, mas não pode usar 1user .
4. É uma linguagem que diferencia maiúsculas de minúsculas. Maiúsculas e minúsculas são significativas. Se você usar uma variável como nome de usuário , não poderá usar USERNAME ou Nome de usuário de para uso pai.
5. Você não pode usar nenhuma palavra-chave (char, int, if, for, while etc) para declaração de variável.
6. O padrão ANSI reconhece um comprimento de 31 caracteres para um nome de variável