it-swarm-pt.tech

Por que o comentário javadoc de classe padrão IntelliJ padrão usa sintaxe não padrão?

Por que o comentário javadoc de classe padrão IntelliJ padrão usa sintaxe não padrão? Em vez de criar uma linha com "Usuário: jstauffer", ele pode criar uma linha com "@author jstauffer". As outras linhas que ele cria (Data e Hora) provavelmente não têm sintaxe javadoc para usar, mas por que não usar a sintaxe javadoc quando disponível?

Para referência, aqui está um exemplo:

/****.____.] * Criado por IntelliJ IDEA. 
 * Usuário: jstauffer 
 * Data: 13 de novembro de 2007 
 * Hora: 11:15:10 AM 
 * Para alterar este modelo, use Arquivo | Configurações | Modelos de arquivo. 
 * /
44
James A. N. Stauffer

Não sei por que o Idea não usa o @author tag por padrão.

Mas você pode alterar esse comportamento acessando File -> Settings -> File Templates e editando o File Header entrada na guia Includes.

A partir de IDEA 14 é: File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header

53
Rob Dickerson

No AndroidStuido 1.0.2 no Mac

Entre em Preferências e depois no espaço esquerdo Modelos de arquivo e código Depois de selecionar os modelos de arquivo e código no lado direito, selecione inclui guia selecione arquivo Cabeçalho e altere o cabeçalho do arquivo.

6
user1154390

O padrão é legível, utilizável, mas não segue ou sugere nenhum padrão de codificação.

Eu acho que o motivo pelo qual o IntelliJ não usa as tags Javadoc no padrão é para evitar possíveis interferências nos padrões de codificação/javadoc que possam existir nas lojas de desenvolvimento. Deveria ser óbvio para o usuário se o padrão precisar ser modificado para algo mais apropriado.

Onde estou trabalhando, o uso de tags de autor é desencorajado, por vários motivos.

4
brasskazoo

Porque é um modelo de arquivo padrão que você deve alterar para o padrão da sua organização ou para o seu gosto.

Meu melhor palpite.

3
Trampas Kirk

É provável que o snippet de cabeçalho que você mostra seja mais antigo que o javadoc e tenha sido emprestado de algum documento padrão de codificação, provavelmente escrito para C++.

1
Alex B