{"action":"opened","issue":{"url":"https://api.github.com/repos/CIT-SWAT/Android-Guidelines/issues/2","repository_url":"https://api.github.com/repos/CIT-SWAT/Android-Guidelines","labels_url":"https://api.github.com/repos/CIT-SWAT/Android-Guidelines/issues/2/labels{/name}","comments_url":"https://api.github.com/repos/CIT-SWAT/Android-Guidelines/issues/2/comments","events_url":"https://api.github.com/repos/CIT-SWAT/Android-Guidelines/issues/2/events","html_url":"https://github.com/CIT-SWAT/Android-Guidelines/issues/2","id":141892999,"number":2,"title":"Primeiro exemplo do Javadoc pode ser melhorado","user":{"login":"Tiago-Marques","id":8820039,"avatar_url":"https://avatars.githubusercontent.com/u/8820039?v=3","gravatar_id":"","url":"https://api.github.com/users/Tiago-Marques","html_url":"https://github.com/Tiago-Marques","followers_url":"https://api.github.com/users/Tiago-Marques/followers","following_url":"https://api.github.com/users/Tiago-Marques/following{/other_user}","gists_url":"https://api.github.com/users/Tiago-Marques/gists{/gist_id}","starred_url":"https://api.github.com/users/Tiago-Marques/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Tiago-Marques/subscriptions","organizations_url":"https://api.github.com/users/Tiago-Marques/orgs","repos_url":"https://api.github.com/users/Tiago-Marques/repos","events_url":"https://api.github.com/users/Tiago-Marques/events{/privacy}","received_events_url":"https://api.github.com/users/Tiago-Marques/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2016-03-18T15:08:47Z","updated_at":"2016-03-18T15:08:47Z","closed_at":null,"body":"Atualmente o primeiro exemplo do Java doc é:\r\n\r\n_/**\r\n * Descrição do método, qual é sua utilidade.\r\n *\r\n * @param userName - nome do usuário\r\n *\r\n * @return um String com o nome do usuário\r\n */\r\npublic String setUserName(String userName) {\r\n    // código\r\n    return <alguma coisa>;\r\n}_\r\n\r\nMesmo não sendo no foco do Javadoc , estou sugerindo um exemplo mais real sem perder o intuito:\r\n**\r\n/**\r\n * Descrição do método, qual é sua utilidade.\r\n *\r\n * @param lastName - Sobrenome do usuário\r\n *\r\n * @return um String com o nome completo do usuário\r\n */\r\npublic String getUserFullName(String lastName) {\r\n    // código\r\n    return this.firstName + lastName;\r\n}**\r\n\r\nPode ser visto em: https://github.com/Tiago-Marques/Android-Guidelines/wiki\r\n"}}