Convencoes de Codigo e Documentacao. Ingles e Portugues

Oi pessoal

Quando faco um projeto, uso o codigo totalmente em ingles. Isto eh, tem uma classe que chama User e nao Usuario. E chama getName, e nao getNome, etc…

Mas, existe alguma convencao sobre isso? Digo, em relacao a lingua que voce usa pra programar as variaveis e nomes de metodo?

Outra coisa, apesar do codigo em ingles, javadoco em portugues. Parece algo bem burro de se fazer…

Como voces fazem?

javadoco é legal heheheh…:lol:

Pra mim, depende do dia, as vezes escreve tudo em inglês, as vezes tudo em portugues, mas sem perceber, só percebo qnd vem o xefe e diz:

  • Escolha uma língua pra programar !!!

heheheh, qnd deixo pra terminar algo de um dia pro outro a classe fica 1/2 ingles e 1/2 portugues heheheh…

O xefe fica uma arara…( Qnd ele vê )

comigo sai 50% inglês 50% português :slight_smile:

mas o legal é fazer tudo em inglês, fica padronizado.

A grande maioria de tudo - inclusive o javadoc - em português, mesmo porque minhas classes e atributos seguem os mesmos nomes dos objetos do BD.

Um ou outro método especifico, geralmente coisas de Tools, colocamos em inglês porque fica menos chato de ler… até por conta dos acentos, você chamar um método de isLegal() é melhor de ler do que eLegal()

eu tento fazer o máximo possível em português. Isso significa, no meu caso, apenas javadoc.

Porque existe um padrao para acessores, que eh getXXX(), isXXX() e setXXX(). isLegal() pra mim é meio ridículo.

As coisas open source que eu faco sao todas em ingles. o Javadoc do shob eh em ingles. Assim mais gente pode ler (o que eu nao digo eh que a página tá só em portugues, pq começou com um trabalho da facul e nunca mais enncostei nele), quem sabe mais gente aproveita.

Por exemplo, nomes de variáveis às vezes são muito tentadores:

  private Class class;
  public Class getClass() {
    return class;
  }
  public void setClass(Class class) {
    this.class = class;
  }

Olha só. Isso não compila nem com reza brava. Mas, pra 170 milhões de pessoas, se a variável chamar-se classe fica tudo igualmente claro.

Hehehehe…

[]s!!

[quote=“dukejeffrie”]Porque existe um padrao para acessores, que eh getXXX(), isXXX() e setXXX(). isLegal() pra mim é meio ridículo.
[/quote]

Tudo bem, não foi um bom exemplo, afinal isXXX() é um padrão. Agora não precisa ser tosco nos seus comentários!

Faço em inglês quando quero deixa aberto ao público em geral, e em português quem é pro trabalho.

[quote=“dreamspeaker”]
Um ou outro método especifico, geralmente coisas de Tools, colocamos em inglês porque fica menos chato de ler… até por conta dos acentos, você chamar um método de isLegal() é melhor de ler do que eLegal()…[/quote]

Se o teu editor for unicode voce pode usar éLegal()

Eu programo as classes em ingles mesmo, por que em alguns lugares fica mais conveniente por ser uma lingua mais compacta e quando uso algum pattern não preciso colocar a tradução porque normalmente tradução de termos técnicos fica 1 caca.

Porem documento em portugues já que o projeto só vai ter brasileiro mechendo.

A parte de programação eu geralmente deixo em ingles. Até porque é sempre simples de ler. Nunca vi um codigo com termos ou palavras mais complicadas. Ora, a maioria dos programadores vai conseguir entender nome de classes como User, Server, Client, Text and so on. Entretanto, documentação eu sempre escrevo em portugues mesmo.

Até.

Nao, nao, nao!!! Seu exemplo foi ótimo!! Nao quis ofender, nao!! Eu só usei seu método pra nao ter que inventar outro. Acho que pra mim, a palavra “ridículo” tem um significado mais leve do que pra você. Por favor, me desculpe. Eu quis dizer “passível de provocar risos nos leitores”… 8)

Eu tinha um prof na facul que descontava 0,1 da questao quando ele encontrava coisas assim. No começo eu me revoltei, mas hoje eu sou a favor… : ))

[]s!!

Putz, essa questão sempre me pega. Quando eu estou programando, eu entro em “english mode”, e um getDadosPessoais pra mim é uma atrocidade. O problema é que, na grande maioria das vezes, sempre tem uma ou outra palavra no vocabulário da aplicação que não dá pra passar pro inglês direito. Agência (bancária) talvez seja um bom exemplo. getAgency? Sei lá, fica estranho. Mas mesmo assim eu acabo usando…

Outra disparidade forte são os bancos de dados… geralmente, quem faz o modelo do banco já te deu o vocabulário da aplicação, e vc acaba tendo que usar aquilo. Então, mesmo em english mode, um monte de coisa acaba sendo declarada em português. E aí se repete o fenômeno do 50% inglês e 50% português no código…

O problema é quando a empresa em que você trabalha e os DBA’s são franceses. Aí você consegue a proeza de desenvolver 50% inglês, 25% português e 25% francês. “C’est une très difficile compréhension” :shock: .

…e viva a internacionalizacao :wink:

Ja’ imaginou pegar um codigo pra manter, e de repente encontrar um monte de comentarios em hindi ou sueco? Senta e chora, ne’? :smiley:

Eu me lembro que no meu projeto do TCC havia documentação, comentários, e até diagramas com “punknes” e “traficantenes”, explico, no meu projeto tinha um metaleiro… e outro que vivia com a galera do tráfico… conhecia todo mundo… a primeira vez que li o código de um deles fiquei maluco. Liguei pra casa do cara a uma da manhã xingando ele…

Eu tento fazer as coisas em inglês, mas como ele não é muito bom, ficam os métodos e classes com nomes em inglês, quando possível pois o BD é tudo em português, e a documentação fica na nossa língua natal devido a dificuldade em escrever na dos ianques…

Gustavo Guilherme BacK

O traficante não quis te matar?

Não, não… ele conhecia a galera, mas isso não significa que ele era usuário ou traficante…

Ops! Não vamos fugir do tópico… ele está bom de mais pra ser desvirtuado.

Gustavo Guilherme BacK

Em 98 eu tentei desenvolver um plugin em C++, para o Photoshop, a pedidos de um cara. Eu nem manjava muito de inglês e documentação do SDK deles era fraca, também foi um caso.

Claro que não foi pra frente!

Além do que o cara queria controlar impressão e não lembro mais o que, o que era impossível pelo plugin do Pshop.

Na alemanha eu programava e comentava em ingles… campos eram traduzidos do alemao para o ingles para que outros que viessem pudessem entender
Os javadocs estavam em ingles, a documentacao era feita em alemao.

No gujchat esta tudo em ingles (logico)… e no trabalho costumo usar tudo em ingles… a nao ser que seja um assunto que desconheco completamente ai tem uns getNomeDoBixo() entao ja planejo pra ficar tudo com portuga…
Comentarios e documentacao em portugues

Aproveitando um pouco o topico, e quanto a padrões de formatação?! Como vcs usam?! Eu geralmente crio codigo assim:

    public static void fazAlgo() {
        Iterator it = lista.iterator();
        while(it.hasNext()) {
            if(algumaCoisa) {
                it.remove();
            }   else {
                //faz outra coisa
            }
        }
    }

Mas é comum ver codigos assim:

    public static void fazAlgo() {
        
        Iterator it = lista.iterator();
        while(it.hasNext()) 
        {
            if(algumaCoisa) 
            {
                it.remove();
            }
            else 
            {
                //faz outro coisa;
            }
        }
    }

Há ainda programadores que deixam poucas linhas em branco no codigo e eu acho isso ruim para a legibilidade. Lembro tambem que meu professor de Java certa vez falou sobre quando usar for ou while. Numa regra geral, que sigo até hoje, uso for quando sei que devo executar o loop de x a y, ou seja, quantidades “bem definidas” e while quando não posso inferir até onde o laço vai executar.

Até.

Indentação de código costumava ser um assunto mais complicado até surgirem ferramentas como o Jalopy, Eclipse e IDEA :wink:

Hoje, eu configuro o editor pra ficar com a configuração de indentação que eu gosto, e mando ele reformatar o código sempre que eu vou alterar ele. Simples :smiley: