코드 냄새 - DirName 및 파일-JS 튜토리얼-php.cn

코드 냄새 - DirName 및 파일

Patricia Arquette

풀어 주다： 2024-11-11 07:17:03

원래의

649명이 탐색했습니다.

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

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

문제

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

솔루션

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

문맥

단일 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;
    }
}

로그인 후 복사