지나치게 복잡한 명명으로 인해 혼란이 발생함

TL: DR: 이름을 지정하는 것은 어렵습니다. 불필요하게 우연한 복잡성으로 인해 이름을 지정하는 것이 더 어려워지지 마세요.

문제

• 불분명하고 오해의 소지가 있으며 모호하고 모호한 이름

• 중복되는 용어

• 혼란스러운 추상화

• 암호적인 약어

솔루션

1. 명명 규칙 단순화

2. 일관성 보장

3. 불필요한 전문 용어 피하기

4. 행동에 따라 설명이 포함된 이름을 사용하세요.

5. 일관적인 용어 유지

문맥

루드비히 비트겐슈타인(Ludwig Wittgenstein)은 언어 오용으로 인해 많은 혼란이 발생한다고 주장했습니다.

이는 이름을 지나치게 복잡하게 하거나, 은유를 혼합하거나, 일관되지 않은 용어를 사용할 때 발생합니다.

명확하지 않게 클래스, 메소드 또는 변수의 이름을 지정하면 다른 사람들이 헤쳐나가기 힘든 언어적 미로가 만들어집니다.

이로 인해 버그가 발생하고 유지 관리가 더 어려워지며 팀이 좌절하게 됩니다.

샘플 코드

잘못된

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

오른쪽

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

발각

[X] 매뉴얼

이름이 길어지기 시작하거나 "Abstract", "Manager", "Handler", "Helper" 또는 "Data"가 너무 자주 표시되면 이 냄새를 감지할 수 있습니다.

또 다른 징후는 예를 들어 코드 검토에서 다른 개발자에게 이름이 무엇을 의미하는지 설명해야 할 때입니다.

태그

• 이름 지정

수준

[X] 초보자

AI 세대

AI 생성기는 가능한 모든 컨텍스트를 포괄하는 장황하고 일반적인 이름을 생성하여 이러한 냄새를 생성하는 경우가 많습니다.

그들은 다양한 분야의 전문가이고 코드를 작성하지만 지시가 없는 한 두 가지를 동시에 수행하지 않는 경우가 많습니다.

AI 탐지

AI 생성기는 때때로 "이름 단순화" 또는 "중복 용어 제거"와 같은 간단한 리팩토링 지침으로 이 냄새를 해결할 수 있지만 더 깊은 맥락을 이해하는 데 어려움을 겪습니다.

결론

코드의 언어적 혼란으로 인해 불필요한 복잡성이 발생합니다.

명확하고 일관되며 간단한 이름 지정을 사용하여 코드를 더 쉽게 읽고 유지 관리할 수 있습니다.

처지

코드 냄새 22 - 도우미

맥시 콘티에리 ・ 2020년 11월 12일

#앗 #도우미 #코드뉴비 #초보자

코드 냄새 38 - 추상 이름

맥시 콘티에리 ・ 2020년 11월 30일

#앗 #코드뉴비 #네이밍 #웹개발

코드 냄새 197 - 불필요한 컨텍스트

맥시 콘티에리 ・ '23년 2월 21일

#웹개발 #초보자 #프로그램 작성 #지도 시간

코드 냄새 113 - 데이터 명명

맥시 콘티에리 ・ 2022년 1월 5일

#앗 #웹개발 #데이터 베이스 #리팩토링

추가 정보

비트겐슈타인의 언어혼란 개념

소프트웨어란 무엇입니까?

맥시 콘티에리 ・ 2020년 10월 8일

#앗 #단단한 #초보자 #설계

이름이 정확히 무엇인가요? — 1부: 퀘스트

맥시 콘티에리 ・ 2021년 2월 9일

#코드뉴비 #지도 시간 #웹개발 #앗

이름이란 정확히 무엇입니까 - 2부 재활원

맥시 콘티에리 ・ 2021년 5월 23일

#지도 시간 #코드뉴비 #프로그램 작성 #웹개발

부인 성명

코드 냄새는 제 생각입니다.

크레딧

Unsplash의 Mimi Thian 사진

명확한 언어의 가장 큰 적은 성실하지 못한 태도입니다.

조지 오웰

소프트웨어 엔지니어링에 대한 좋은 인용문

맥시 콘티에리 ・ 2020년 12월 28일

#코드뉴비 #프로그램 작성 #인용 부호 #소프트웨어

이 글은 CodeSmell 시리즈의 일부입니다.

코드에서 냄새나는 부분을 찾는 방법

맥시 콘티에리 ・ 2021년 5월 21일

#코드뉴비 #지도 시간 #코드품질 #초보자