• Revista PROGRAMAR: Já está disponível a edição #53 da revista programar. Faz já o download aqui!

Nazgulled

Itálicos em Negritos em Javadoc

13 mensagens neste tópico

De momento estou a usar o JCreator pelo que não sei se o que quero fazer é possível porque estou com uns problemas, mas estou na ideia de que quando usei o Eclipse, poderíamos usar negritos e itálicos na documentação das nossas classes.

Duas questões:

1) É realmente possível usar negritos e itálicos em Javadc? Segundo li, pode-se usar HTML, logo, posso usar <em>Itálico</em> e <strong>Negrito</strong> no Javadoc ou isto não é possível, ou é mas de outra maneira?

2) A ideia não é usar negritos/itálicos à toa ou como me apetece, mas usar segundo as mesmas convenções que são feitas na documentação oficial do JDK. Se é que realmente existe negritos/itálicos na documentação oficial do JDK. Existe? Se sim, quais as convenções?

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Sim podes ter o itálico não me lembro mas o negrito é <B></B> podes usar quase todas as tags standart do html.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Li por alto, mas fiz um search lá no documento e não encontro nada que ajude aos itálicos/negritos...

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Tem lá por exemplo, quando deves usar fontes monospace.

Os negritos, nem são muito utilizados, normalmente é quando queres realçar um ponto, ou alertar para pormenores de implementação.

Os itálico aparecem muitas vezes quando usas termos "técnicos".

Mas vê a secção "A Style Guide", que deve parece-me que tem lá o que interessa.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Podes usar HTML normal, <em></em> para itálico o <b></b> para negrito, tal como o magician disse.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Li noutro documento que para itálico era <i></i> (HTML4), <em></em> é em XHTML.

O problema é que eu não posso testar isto, o raio do JCreator diz que não existe documentação nas minhas classes quando ela está lá...

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Agora é que me apanhaste, realmente sempre vi os comentários de Javadoc com <em></em> e nunca vi com <i></i>, não te posso dizer se os dois funcionam, posso dizer-te que o <em></em> não só funciona como é o usado em todo o código da plataforma.

Não conheço esse editor mas deve ser possível navegar para dentro de uma classe, o comum nos IDEs que usei foi usar o atalho ctrl+clique esquerdo no nome de uma classe, por exemplo da classe String, e o editor mostrava-me o código fonte dessa classe, assim podias ver vários exemplos de como usar o Javadoc dado que todas as classes da plataforma estão documentadas.

O editor não te permite gerar a documentação de forma simples, ficava logo testado.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Nope, este editor é assim um bocado po "funcionalidade reduzida" e com alguns bugs... Ainda tem um caminho longo a percorrer, mas espero que chegue lá.

Estou a usar este porque é muito mas mesmo muito parecido com o Visual Studio em termos de aspecto e eu curto bués o Visual Studio, é dos melhores (se não mesmo o melhor) IDE alguma vez feito para programação, se houvesse um assim para todas as linguagens eu não me importava.

E como tal, estou a usa-lo... Mas estes pequenos problemas estão a chatear-me e se calhar vou voltar ao Eclipse... (Não me sugiram o NetBeans, já o experimentei e não gostei nada... ;)).

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Estive a experimentar e o browser do netbeans aceita tanto a tag <i> como a <em>, pelo que não deverá haver problemas em usar uma ou outra, acho que os browsers acabam por colocar ambas da mesma maneira, em itálico.

Quanto ao IDE, usa o que melhor se adaptar a ti, posso dizer que para mim até o notepad é melhor que o VS ;), mas desde que trabalhes bem com uma ferramenta é o que importa, cada um tem a sua forma de usar um editor.

Se calhar a minha aversão ao VS vem do facto de o ter usado pela primeira vez para programar em VB, acho que pode ter sido por arrasto, se bem que o usei para ASP.net e fiquei na mesma desiludido, más experiências :D

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Não sabes o que dizes :D o VS é o melhor IDE de programação alguma vez feito, assim como o Office é outro dos realmente bons produtos da Microsoft.

Se calhar as tuas aversões foram mais às linguagens do que propriamente ao IDE ;).

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Como disse, a questão do VS pode estar relacionada com o facto de ter usado o mesmo para programar VB mas no caso do ASP desiludiu-me bastante, estava à espera de um IDE que se comportasse melhor, infelizmente correu mal, o IDE rebentava por tudo e por nada, o designer não funcionava, enfim, um conjunto de erros que me atrasavam mais que ajudavam.

O VS até pode ser um bom IDE mas não vejo nele nada que não veja noutros.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Nunca o usei para a Web por isso nesse campo não falo.

Eu vejo. E uma das coisas mais importantes para mim, simplicidade. Para mim, o VS é muito mais simples que o Eclipse por exemplo. E acho que nenhum IDE existente tenha um UI tão simples e moderno como o VS. Eu olho para a maior parte dos outros IDE's e só vejo "bloat". No VS isso não acontece, mas pronto, isto só são algumas das minhas razões.

Para programadores mais experientes/profissionais, existem muitas mais... A maioria gosta do VS.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Crie uma conta ou ligue-se para comentar

Só membros podem comentar

Criar nova conta

Registe para ter uma conta na nossa comunidade. É fácil!


Registar nova conta

Entra

Já tem conta? Inicie sessão aqui.


Entrar Agora