代碼氣味 - 目錄名和文件-js教程-PHP中文網

代碼氣味 - 目錄名和文件

Patricia Arquette

發布： 2024-11-11 07:17:03

原創

650 人瀏覽過

避免路徑變數命名不明確

TL;DR：使用清晰的名稱可以更好地理解程式碼。

問題

變數用途不明確
雙射故障
誤導性上下文
重複程式碼
更難維護
可讀性降低
縮寫
認知負荷增加

解決方案

尊重雙射
使用準確的名稱
避免歧義
保持上下文清晰
擷取可重複使用的程式碼
遵循命名約定
用規則具體化名稱

情境

處理單一 fileName 或 directoryPath 時，像 file 或 dirName 這樣的模糊名稱會造成混亂。

一個檔案應該代表一個檔案
fileName 應代表檔案的名稱
fileContents 應代表文件的內容
fileHandler 應該表示指向外部資源的指標
dirName 應該是 directoryPath

清晰的名稱，例如用於名稱的 fileName 和用於目錄的 directoryPath 來傳達每個變數的角色。

當您命名變數檔案時，可能會讓其他人對其用途感到困惑。它存儲文件對象還是僅存儲文件名？

當您命名變數dirName而不是directoryName時，它會導致歧義。

清晰且具有描述性的變數名稱可以提高程式碼的可讀性和可維護性，尤其是在協作環境中。

範例程式碼

錯誤的

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

登入後複製