Tornar o código Java do Eclipse formatador ignorar os comentários de bloco
https://stackoverflow.com/questions/1024886
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPergunta
Existe uma maneira de fazer built-in Java de código do Eclipse formatador ignorar os comentários? Sempre que eu executá-lo, verifica-se o seguinte:
/*
* PSEUDOCODE
* Read in user's string/paragraph
*
* Three cases are possible
* Case 1: foobar
* do case 1 things
* Case 2: fred hacker
* do case 2 things
* Case 3: cowboyneal
* do case 3 things
*
* In all cases, do some other thing
*/
a este:
/*
* PSEUDOCODE Read in user's string/paragraph
*
* Three cases are possible Case 1: foobar do case 1 things Case 2: fred
* hacker do case 2 things Case 3: cowboyneal do case 3 things
*
* In all cases, do some other thing
*/
Eu já brinquei com Windows> Preferências> Configurações de Java> Estilo de código> Formatter mas não consegue encontrar um para manter comentário formatação. Estou usando o Eclipse 3.4.0.
Solução
Atualização de 2010, como apontado pelo OP e nesta resposta , o // @formatter:off corda especial em Eclipse 3.6 é suficiente.
Não estava disponível no momento da pergunta.
resposta Original: Junho de 2009, Eclipse 3.4 / 3.5
Com o Java Formatter (Windows > Preferences > Java > Code Style > Formatter), você pode criar um novo perfil Formatter.
Na guia Comentários (em eclipse3.5), você pode ter certeza, no "Javadoc comment settings", para desmarcar "Format HTML tags".
Verifique também o "Never join lines" na seção "General settings".
Em seguida, o seu comentário deve ser escrito como:
/**
* PSEUDOCODE
* Read in user's string/paragraph
*
* Three cases are possible:
* <dl>
* <dt>Case 1: foobar</dt>
* <dd> do case 1 things</dd>
* <dt>Case 2: fred hacker</dt>
* <dd> do case 2 things</dd>
* <dt>Case 3: cowboyneal</dt>
* <dd> do case 3 things</dd>
* </dl>
* In all cases, do some other thing
*/
Nota: Fiz um Javadoc comentário, e não um simples comentário, como eu acredito que um comentário com muito texto em que pode ser mais bem colocado na frente de um método. Além disso, seções Javadoc ter parâmetros mais de formatação para brincar.
Se ele está na frente de um método (true Javadoc), o HTML tags de <dl>, <dt> e <dd> vai ajudar a apresentá-lo corretamente dentro da visão Javadoc.
Outras dicas
Não há outra solução que você pode usar para suprimir a formatação de blocos de comentários específicos. Use /*- (note o hífen) no início do bloco de comentário, e a formatação
não será afetada se você formatar o resto do arquivo.
/*- * Here is a block comment with some very special * formatting that I want indent(1) to ignore. * * one * two * three */
Eu só aprendeu com um colega de trabalho que oferece Eclipse tags de formatação especiais que podem ser usados ??para isso:
// @formatter:off
/*
* ╔════════╦═══════╦══════════╗
* ║ Month ║ Sales ║ Position ║
* ╠════════╬═══════╬══════════╣
* ║ June ║ 44k ║ 2nd ║
* ║ July ║ 39k ║ 2nd ║
* ║ August ║ 49k ║ 4th ║
* ╚════════╩═══════╩══════════╝
*
* This comment shouldn't be formatted, and will now be ignored by the formatter.
*/
// @formatter:on
Note que você pode precisar de habilitar manualmente esse recurso através do menu Preferências ? Java> Código Style> Formatter, clicando em Editar , selecionar a> Off / On Etiquetas / strong guia e verificação Ativar Off / On etiquetas ( fonte ).
A rápida no Google para a cadeia @formatter: off me trouxe para esta outra resposta SO , que mencionou esse recurso no contexto de desativar o formatador de blocos de código. Eu já confirmou que ele funciona para comentários de linha, os comentários "normais" de blocos e blocos de comentários Javadoc também.
Outra possibilidade é usar
de HTML no Javadoc:/** * <pre> * this * is * kept * as * is * </pre> */Pelo menos é assim que eu tendem a incorporar meu ASCII-art em comentários do código fonte:)
Surround o texto específico com etiquetas <pre> </pre>.
Em Eclipse 3.4: Preferências, Java-> Código Style-> Formatter, em seguida, editar perfil, guia comenta. Há um monte de opções lá para controlar comentário formatação.
Se você quiser para suprimir a formatação em eclipse, você pode sempre envolver conteúdo que pretende NÃO SER formatada em tag <pre>UNFORMATTED CONTENT</pre>. formatador Javadoc irá detectar que tag , e deixar tudo entre que as tags não formatados.
Pros:
- Resto do Javadoc ainda está formatado
- saída html do Javadoc será "não formatado", mas também porque de tags pre
Contras:
- Não vendo um
Uma solução é adicionar pré tag para os comentários que você não quer eclipse para o formato
/**
* <pre>
* this part
* is
* out of
* format
*
* </pre>
*/
É dependentes do idioma.
Por exemplo, se trabalhar com javascript, você iria para "Janela -> Preferências -> Javascript -> Código Style -> Formatter". E, em seguida, editar as opções formatador
Editar (Perguntas refletindo as alterações registadas OP
Para editar o código java formatação, ir para "Janela -> Preferências -> Java -> Código Style -> Formatter"
No topo do painel, você verá
Activo Perfil:
Eclipse [embutido]
De lá você tem um botão para a direita, "Editar", e dois abaixo, "New ..." e "Importar ...". Eu recomendaria Editando o perfil existente.
Na caixa de diálogo Editar perfil, há uma série de abas no topo. A última guia é "Comentários". Para desativar completamente o comentário a formatação, desmarque a opção "Ativar comentário Javadoc formatação", "Ativar comentário de bloco formatação", "Ativar comentário linha formatação" e "Ativar comentário cabeçalho formatação".
Você pode alterar isso em Windows - Preferências - Java - Código Style - Formatter, que clique no botão Editar .., encontrar comentários, escolher o Nunca linhas de associação.
Em seguida, ele deve estar OK.
Tente este. Isso funcionou para mim. Com o Java Formatter (Windows> Preferências> Java> Código Style> Formatter), você pode criar um novo perfil Formatter do existente e, em seguida, editá-lo.
Se o Eclipse não permite salvar este, em seguida, criar um novo e salvar nisso.
