代碼氣味 - 目錄名和文件

避免路徑變數命名不明確

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中文網其他相關文章！