Jump to content

Itálicos em Negritos em Javadoc


Guest id194
 Share

Recommended Posts

Guest id194

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?

Link to comment
Share on other 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.

Link to comment
Share on other sites

Guest id194

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á...

Link to comment
Share on other 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.

Link to comment
Share on other sites

Guest id194

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... 😉).

Link to comment
Share on other 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 😄

Link to comment
Share on other sites

Guest id194

Não sabes o que dizes 😄 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 😉.

Link to comment
Share on other 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.

Link to comment
Share on other sites

Guest id194

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.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

×
×
  • Create New...

Important Information

By using this site you accept our Terms of Use and Privacy Policy. We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.