12 ŞUBAT 2009, PERŞEMBE
Birden fazla satır kodu Javadoc yorum örneği
Bir yöntem için Javadoc yorum eklemek istediğim küçük bir kod örneği var.
/**
* -- ex: looping through List of Map objects --
* <code>
* for (int i = 0; i < list.size(); i ) {
* Map map = (Map)list.get(i);
* System.out.println(map.get("wordID"));
* System.out.println(map.get("word"));
* }
* </code>
*
* @param query - select statement
* @return List of Map objects
*/
Sorun örnek, herhangi bir hat ile Javadoc tatili zor okumak için yapım görünür kodudur.
-- ex: looping through List of Map objects -- for (int i = 0; i list.size(); i ) { Map map = (Map)list.get(i); System.out.println(map.get("wordID")); System.out.println(map.get("word")); }
Parameters
query - - select statement
Returns:
List of Map objects
Kod etiketi Satır sonları ele yanılgısına sanırım benim. Javadoc açıklamaları biçiminde kod örnekleri için en iyi yolu nedir ?
CEVAP
12 ŞUBAT 2009, PERŞEMBE
Ek olarak bahsedildiği <pre>
etiketleri sen de kullan @code
JavaDoc açıklama, hangi yapar hayat çok daha kolay gelince HTML varlıkları sorunları (özellikle ile Jenerik), örneğin:
* <pre>
* {@code
* Set<String> s;
* System.out.println(s);
* }
* </pre>
Doğru HTML çıktısı verecektir:
Set<String> s;
System.out.println(s);
@code
blok (veya <code>
etiketini kullanarak) ihmal bu gibi HTML neden olur:
Set s;
System.out.println(s);
Bunu Paylaş:
Nasıl JavaScript kodu birden fazla sat...
Bir c# fonksiyonu birden fazla satır o...
Vim içinde nasıl etkin bir şekilde bir...
Yakalamak birden fazla satır istisnala...
Nasıl özel bir ayırıcı ile bir dosya i...