코드 냄새 - DirName 및 파일

경로 변수에 대한 모호한 이름 지정 방지

TL;DR: 코드를 더 잘 이해하려면 명확한 이름을 사용하세요.

문제

• 불분명한 변수 용도
• 전단사 오류
• 오해의 소지가 있는 문맥
• 반복되는 코드
• 더욱 강화된 유지관리
• 가독성 감소
• 약어
• 인지 부하 증가

솔루션

1. 전관을 존중하세요
2. 정확한 이름을 사용하세요
3. 모호함을 피하세요
4. 문맥을 명확하게 유지하세요
5. 재사용 가능한 코드 추출
6. 명명 규칙을 따르세요
7. 규칙에 따라 이름을 구체화하세요

문맥

단일 fileName 또는 directoryPath를 처리할 때 file 또는 dirName과 같은 모호한 이름은 혼란을 야기합니다.

• 파일은 파일
을 나타내야 합니다.
• fileName은 파일 이름을 나타내야 합니다
• fileContents는 파일의 내용을 나타내야 합니다
• fileHandler는 외부 리소스에 대한 포인터를 나타내야 합니다
• dirName은 directoryPath여야 합니다.

이름의 경우 fileName, 디렉터리의 경우 directoryPath와 같은 명확한 이름은 각 변수의 역할을 전달합니다.

변수 파일의 이름을 지정하면 다른 사람이 용도를 혼동할 수 있습니다. 파일 객체를 저장합니까, 아니면 파일 이름만 저장합니까?

directoryName 대신 dirName 변수 이름을 지정하면 모호해집니다.

명확하고 설명적인 변수 이름은 특히 협업 환경에서 코드 가독성과 유지 관리성을 향상시킵니다.

샘플 코드

잘못된

function importBoardGameScores(file) {
  if (file) {
    const data = fs.readFileSync(file, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryScores(dirName) {
  // 'dir' is an abbreviation
  const files = fs.readdirSync(dirName);
  files.forEach(file => {
    const data = fs.readFileSync(`${dirName}/${file}`, 'utf-8');
    // Process each file's board game scores...
  });
  }
}

오른쪽

function importBoardGameScores(fileName) {
  if (fileName) {
    const data = fs.readFileSync(fileName, 'utf-8');
    // Process board game scores...
  }
}

function importDirectoryBoardGamesScores(directoryPath) {
    const fileNames = fs.readdirSync(directoryPath);
    // Note the variable holding filenames 
    // and not files

   fileNames.forEach(filename => {
        const fullPath = path.join(directoryPath, filename);
        const scores = importBoardGameScores(fullPath);
        allScores.push(scores);
   });

   return allScores.flat();


// You can also reify the concept of a filename
// And avoid repeating the rules everywhere

class Filename {
    value;

    constructor(value) {
        this.validateFilename(value);
        this.value = value;
    }

    validateFilename(value) {      
        const invalidCharacters = /[:"/\|?*\x00-\x1F]/g;
        if (invalidCharacters.test(value)) {
            throw new Error
              ('Filename contains invalid characters');
        }

        if (/^[. ]+$/.test(value)) {
            throw new Error
              ('Filename cannot consist only of dots or spaces');
        }

        if (value.length > 255) {
            throw new Error
              ('Filename is too long');
        }
    }

    toString() {
        return this.value;
    }

    get value() {
        return this.value;
    }
}

발각

[X] 반자동

코드 처리 파일이나 file 또는 dirName과 같은 디렉터리 경로에서 일반 이름을 찾으세요.

태그

• 네이밍

수준

[x] 초급

AI 세대

AI 모델은 특정 지침 없이 file 또는 dirName과 같은 모호한 이름을 기본값으로 사용할 수 있습니다.

설명적인 이름 지정 및 코드 추출 지침을 추가하면 AI의 출력이 향상될 수 있습니다.

AI 탐지

AI 도구는 명확한 명명 규칙을 사용하고 중복 코드를 방지하라는 메시지가 표시되면 코드 추출을 제안하여 이 냄새를 해결할 수 있습니다.

시도해 보세요!

기억하세요: AI 도우미는 실수를 많이 합니다

Without Proper Instructions	With Specific Instructions
ChatGPT	ChatGPT
Claude	Claude
Perplexity	Perplexity
Copilot	Copilot
Gemini	Gemini

결론

fileName 및 directoryPath와 같은 정확한 이름을 사용하고 재사용 가능한 메서드를 추출하면 코드 명확성과 유지 관리성이 향상됩니다.

이러한 간단한 방법은 중복을 줄이고 코드를 이해하기 쉽게 유지하는 데 도움이 됩니다.

처지

코드 냄새 33 - 약어

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

#앗 #코드뉴비 #프로그램 작성 #지도 시간

부인 성명

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

크레딧

Unsplash의 Gabriel Heinzer 사진

---

코드는 사람이 먼저 읽고, 기계가 그 다음으로 읽을 수 있도록 작성되어야 합니다.

돈 라브스

소프트웨어 엔지니어링 명언

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

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

---

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

코드에서 이상한 부분을 찾는 방법

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

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

위 내용은 코드 냄새 - DirName 및 파일의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!