É uma boa prática usar a formatação automática do texto?


11

Estou usando o Eclipse e falarei sobre isso como um exemplo, mas tenho certeza de que esse é o caso em qualquer outro IDE.

O Eclipse possui o comando CTRL- Shift- Fque formata automaticamente seu código. É uma boa prática usar esse tipo de formatação? Estou perguntando no contexto de um grande projeto no qual pode haver muitos programadores trabalhando nos mesmos arquivos e todos esses são administrados por um sistema CSV.

Obrigado!

Respostas:


12

Sim, ele é.

O Eclipse permite definir seu próprio estilo de código exportável, que você pode compartilhar entre todos os seus desenvolvedores. Se você não deseja configurar seu próprio estilo de formatação, peça aos desenvolvedores que usem a formatação padrão do Eclipse. Mesmo se você usar o padrão, recomendo exportá-lo e colocá-lo em uma unidade de rede compartilhada para uso de todos os desenvolvedores. Se mais tarde, você decidir mudar uma coisa, poderá facilmente.

Independentemente disso, aconselho que você comece o mais rápido possível, o melhor seria no início do projeto e mantenha seu código sempre formatado no formato escolhido. Você deve evitar ter "confirmações de formato" puras durante o desenvolvimento, porque é difícil distinguir das confirmações "reais". O que isso significa na prática é que os desenvolvedores devem ser rigorosos com seus commits .

Além disso, coloco no final porque é apenas minha opinião pessoal, mas considere remover o limite de 80 caracteres por linha (ou estendê-lo para algo maior, temos 120 caracteres aqui), ou seja, se não me engano comprimento da linha de formatação automática padrão no Eclipse. Agora todos temos telas grandes e resoluções de tela grande, então está tudo bem. Sobre esse assunto, consulte a pergunta O limite de 80 caracteres ainda é relevante em tempos de perguntas e respostas para monitores widescreen ; então você poderá tomar sua própria decisão.

Edit: Thorbjørn faz um bom argumento sobre a funcionalidade "Formatar sempre que um arquivo é salvo".


5

Sim, é uma prática muito boa. Ele garante que todos concordam como arquivos de origem deve olhar quando está sendo aberto em um editor.

Além disso, tive experiências muito boas com a funcionalidade "Formatar sempre que um arquivo é salvo". (Usamos a configuração padrão do formatador Eclipse).

Ative-o abrindo propriedades do Eclipse e selecione Java -> Editor -> Salvar Ações. Ative "Execute as ações selecionadas ao salvar" e "Formate o código-fonte".

O motivo é naturalmente que o código é sempre formatado, para que você possa formatar à vontade ao editar sem temer quebras de nada. Isso também garante que os logs do repositório de origem sejam precisos (o que é importante ao fazer análises forenses).


Esqueceu disso, bom ponto.
Jalayn

3

Você deve ter um padrão de codificação que todos sigam. Se isso é imposto por ferramentas externas (como indentação) ou IDE, ou manualmente, isso é irrelevante. O que é relevante é que isso deve ser feito antes da confirmação.


3

É uma boa prática seguir um padrão de codificação bem definido em um projeto / empresa. Os meios de fazê-lo podem variar, basta escolher o que for melhor para sua organização. Se todos usarem o Eclipse, você poderá criar um formato de código exportável para seus projetos e distribuí-lo entre os desenvolvedores (o Eclipse também tem a opção de formatar arquivos automaticamente a cada salvamento), no entanto, eu recomendaria a criação de um documento descrevendo o formato escolhido.

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.