代码气味 - 目录名和文件

避免路径变量命名不明确

TL;DR：使用清晰的名称可以更好地理解代码。

问题

• 变量用途不明确
• 双射故障
• 误导性上下文
• 重复代码
• 更难维护
• 可读性降低
• 缩写
• 认知负荷增加

解决方案

1. 尊重双射
2. 使用准确的名称
3. 避免歧义
4. 保持上下文清晰
5. 提取可重用的代码
6. 遵循命名约定
7. 用规则具体化名称

语境

处理单个 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;
    }
}

检测

[X] 半自动

在处理文件或目录路径的代码中查找通用名称，例如 file 或 dirName。

标签

• 命名

等级

[x] 初学者

人工智能一代

AI 模型可能会默认使用不明确的名称，例如 file 或 dirName，无需具体说明。

添加描述性命名和代码提取指南可以改善 AI 的输出。

人工智能检测

人工智能工具可以通过使用清晰的命名约定来修复这种气味，并在提示时建议提取代码以避免冗余代码。

尝试一下！

记住：人工智能助手会犯很多错误

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

结论

通过使用 fileName 和 directoryPath 等精确名称并提取可重用的方法，您可以提高代码的清晰度和可维护性。

这些简单的做法有助于减少冗余并使代码易于理解。

关系

代码气味 33 - 缩写

马克西·孔蒂耶里 ・ 十一月 24 '20

#哎呀 #codenewbie ＃编程 ＃教程

免责声明

代码味道是我的观点。

制作人员

照片由 Gabriel Heinzer 在 Unsplash 上拍摄

---

编写的代码应该首先供人类阅读，然后才是机器阅读。

唐·拉布斯

软件工程精彩名言

马克西·孔蒂耶里 ・ 2020 年 12 月 28 日

#codenewbie ＃编程 ＃引号 ＃软件

---

本文是 CodeSmell 系列的一部分。

如何查找代码中的臭部分

马克西·孔蒂耶里 ・ 21 年 5 月 21 日

#codenewbie ＃教程 #代码质量 #初学者

以上是代码气味 - 目录名和文件的详细内容。更多信息请关注PHP中文网其他相关文章！