代码气味 - 目录名和文件-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;
    }
}

登录后复制