Let's practice writing documentation. In this version of the Person class,
there's a java.comment for getFriends. What's wrong with this documentation
comment? The first sentence shouldn't have a period. The first sentence should
describe the method. There's no at param statement or the at return statement
should describe the method. How would you write this documentation comment?
Vamos a practicar la escritura de documentación. En esta versión de la clase «Person»,
hay un comentario de «javadoc» para «getFriends». ¿Qué tiene de malo este comentario
en la documentación? La primera sentencia no debe tener un punto. La primera frase debe
describir el método. No hay sentencia «@param». La sentencia @return
debe describir al método. ¿Cómo escribirías este comentario en la documentación?
Entraînons-nous à écrire la documentation.
Dans cette version de la classe person, il y a un java.comment pour getFriends.
Quel est le problème avec ce commentaire de documentation?
La première phrase ne devrait pas avoir de point.
La première phrase devrait décrire la méthode.
Il n'y a pas d'instruction @param ou
l'instruction @return devrait décrire la méthode.
Comment écririez-vous ce commentaire de documentation?
ではドキュメンテーションを書く練習です
このバージョンのPersonクラスには getFriendsにJavadocコメントがあります
このコメントの間違いは何でしょうか？
最初の文にピリオドは不要である 最初の文がメソッドを説明する
メソッドを説明する＠paramがない @returnがメソッドを説明している
皆さんはどのようにコメントを書きますか？
문서 작성하는 것을 연습해봅시다. 이 버젼의 person 클래스에는
getFreinds에 대한 자바 주석이 있습니다. 이 문서의 주석에 무슨 문제가 있나요?
첫 번째 문장은 기간이 명시되어 있어야합니다. 첫 번째 문장은
메소드를 설명해야 합니다. @param 코드나 @return 코드가 없습니다.
이 문서에 주석을 어떻게 작성하실 건가요?
Laten we oefenen met het schrijven van documentatie.
In deze versie van de klasse Person is er een java.comment voor getFriends.
Wat scheelt er met dit commentaar op de documentatie?
De eerste zin zou geen punt moeten hebben.
De eerste zin moet de methode beschrijven.
Er is geen instructie @param
anders moet de instructie @return de methode beschrijven.
Hoe zou je dit commentaar in de documentatie schrijven?
Hãy luyện tập viết documentation. Trong version này của Person class,
có một javadoc comment để getFriends. Có điều gì không đúng với documentation comment này?
Câu đầu tiên không nên có tiền tố. Câu đầu tiên nên mô tả method.
Không có dòng @param hay là @return
nên mô tả method. Bạn sẽ viết comment này như nào?