클린 코드 관점에서 이 주석은 괜찮은지 판단 좀 부탁드립니다.

Question

안녕하세요 자바 서버 개발자를 준비 중인 학생 입니다. 클린 코드, 이펙티브 자바 책을 읽으며 기존의 레거시 코드를 리펙터링 하고 있었습니다. 그러다 여러가지를 Extract Method로 변경하게 되어서 Service layer에 많은 부분을 차지 하게 되었습니다. 그래서 이 부분 부터는 Extract Method 입니다. 라는 주석을 달려고 하는데요 좋은 선택인가요?? 의미없는 주석은 다 필요 없고 메서드 명으로 모두가 아하 할 수 있는 코드를 짜라고 클린 코드 저자 robert.c.martin 이 말하지만 정말 세상에서 변수명 메서드명 짓기 만큼 시간 많이 잡아 먹고 까다로운게 없는게 같은데... Extract Method도 전부 메서드명을 리펙터링해서 주석없이 아 이건 Extract Method 구나 할 수 있도록 리펙토링 하는게 좋을까요?아래는 문제의 코드 입니다.!! @Slf4j @RequiredArgsConstructor @Service public class RestaurantService { private final RestaurantRepository restaurantRepository; private final MenuItemRepository menuItemRepository; private final ReviewRepository reviewRepository; public void addRestaurant (RestaurantRequest restaurantRequestDTO) { restaurantRepository.save(restaurantRequestDTO.toEntity(restaurantRequestDTO)); } @Transactional(readOnly = true) public List findAllRestaurantResponses () { return Collections.unmodifiableList(RestaurantResponse.listOf(restaurantRepository.findAll())); } @Transactional(readOnly = true) public RestaurantDetailResponse findRestaurantDetail (Long restaurantId) { Restaurant restaurant = findRestaurantById(restaurantId); return getRestaurantDetailResponse(restaurantId, restaurant); } @Transactional public void updateRestaurant(Long restaurantId, RestaurantRequest restaurantUpdateRequest) { Restaurant restaurant = findRestaurantById(restaurantId); restaurantUpdate(restaurant, restaurantUpdateRequest); } @Transactional public void deleteRestaurant(Long restaurantId) { Restaurant restaurant = findRestaurantById(restaurantId); restaurantRepository.delete(restaurant); } // 이 아래 부턴 Extract Method private RestaurantDetailResponse getRestaurantDetailResponse (Long restaurantId, Restaurant restaurant) { List menuItems = menuItemRepository.findMenuItemByRestaurantId(restaurantId); List reviews = reviewRepository.findReviewByRestaurantId(restaurantId); RestaurantDetailResponse restaurantDetailResponse = RestaurantDetailResponse.of(restaurant); restaurantDetailResponse.setMenuItems(menuItems); restaurantDetailResponse.setReviews(reviews); return restaurantDetailResponse; } private void restaurantUpdate(Restaurant restaurant, RestaurantRequest restaurantUpdateRequest) { restaurant.updateRestaurant(restaurantUpdateRequest.toEntity(restaurantUpdateRequest)); } private Restaurant findRestaurantById(Long restaurantId) { return restaurantRepository.findById(restaurantId) .orElseThrow(RestaurantNotFoundException::new); } }

WRITE_IN_DART✎ · Answer

조직 내에 전파가 잘 된다면 괜찮아보입니다.

클린 코드 관점에서 이 주석은 괜찮은지 판단 좀 부탁드립니다.

1개의 답변

Q&A 목록