Undocumented method found JAVA-D1001
Documentation
Minor
5 months ago
—
2 years old
Consider adding a doc comment for findAllByUser
25 @Query("SELECT c FROM Comment c WHERE c.post = ?1 ORDER BY c.date DESC")
26 List<Comment> findAllByPost(Post post);
27
28 @Query("SELECT c FROM Comment c WHERE c.user = ?1 ORDER BY c.date DESC")29 List<Comment> findAllByUser(User user);30}
Consider adding a doc comment for findAllByPost
22 @Query("SELECT c FROM Comment c WHERE c.post.id = ?1 ORDER BY c.date DESC")
23 List<Comment> findCommentByPostByPage(UUID post, Pageable pageable);
24
25 @Query("SELECT c FROM Comment c WHERE c.post = ?1 ORDER BY c.date DESC")26 List<Comment> findAllByPost(Post post);27
28 @Query("SELECT c FROM Comment c WHERE c.user = ?1 ORDER BY c.date DESC")
29 List<Comment> findAllByUser(User user);Consider adding a doc comment for findCommentByPostByPage
19 */
20@Repository
21public interface CommentRepository extends JpaRepository<Comment, UUID> {
22 @Query("SELECT c FROM Comment c WHERE c.post.id = ?1 ORDER BY c.date DESC")23 List<Comment> findCommentByPostByPage(UUID post, Pageable pageable);24
25 @Query("SELECT c FROM Comment c WHERE c.post = ?1 ORDER BY c.date DESC")
26 List<Comment> findAllByPost(Post post);Consider adding a doc comment for updateUser
31 @Query("SELECT u FROM User u WHERE u.username LIKE %?1% ORDER BY u.username DESC")
32 List<User> search(String username, Pageable pageable);
33
34 @Query("UPDATE User u SET u.bio = :bio WHERE u.id = :id")35 @Modifying36 @Transactional37 void updateUser(@Param("bio") String bio, @Param("id") UUID id);38}
Consider adding a doc comment for search
28 @NotNull
29 Optional<User> findById(@NotNull UUID uuid);
30
31 @Query("SELECT u FROM User u WHERE u.username LIKE %?1% ORDER BY u.username DESC")32 List<User> search(String username, Pageable pageable);33
34 @Query("UPDATE User u SET u.bio = :bio WHERE u.id = :id")
35 @Modifying
Description
This method does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a method is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
This method appears to return an address string based on its name and the return type, but it is hard to say anything further about it. We neither know if the address will be formatted in a special way nor are we given any useful information regarding the returned value.
String getAddress() {
// ...
}
Recommended
Provide a detailed description of what the method does.
/**
* Returns the address in 3 line format,
* with street address on line 1, area/city on line 2
* and state and country as well as postal code on line 3.
*/
String getAddress() {
// ...
}