Bau Kod - DirName dan Fail

Elakkan Penamaan Samar-samar untuk Pembolehubah Laluan

TL;DR: Gunakan nama yang jelas untuk pemahaman kod yang lebih baik.

Masalah

• Tujuan berubah yang tidak jelas
• Kesalahan Bijection
• Konteks yang mengelirukan
• Kod berulang
• Penyelenggaraan yang lebih keras
• Kebolehbacaan dikurangkan
• Singkatan
• Beban kognitif yang meningkat

Penyelesaian

1. Hormati Bijection
2. Gunakan nama yang tepat
3. Elakkan kekaburan
4. Pastikan konteks jelas
5. Ekstrak kod boleh guna semula
6. Ikuti konvensyen penamaan
7. Ubah nama dengan peraturannya

Konteks

Apabila mengendalikan satu fileName atau directoryPath, nama samar-samar seperti fail atau dirName mewujudkan kekeliruan.

• Satu fail hendaklah mewakili Fail
• Nama fail hendaklah mewakili nama fail
• Kandungan fail hendaklah mewakili kandungan fail
• Sebuah Pengendali fail harus mewakili penunjuk kepada sumber luaran
• dirName hendaklah directoryPath

Kosongkan nama seperti fileName untuk nama dan directoryPath untuk direktori menyampaikan peranan setiap pembolehubah.

Apabila anda menamakan fail berubah-ubah, ia boleh mengelirukan orang lain tentang tujuannya. Adakah ia menyimpan objek fail atau hanya nama fail?

Apabila anda menamakan pembolehubah dirName dan bukannya directoryName, ia membawa kepada kekaburan.

Nama pembolehubah yang jelas dan deskriptif meningkatkan kebolehbacaan dan kebolehselenggaraan kod, terutamanya dalam persekitaran kolaboratif.

Kod Contoh

salah

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

Betul

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

Pengesanan

[X] Separa Automatik

Cari nama generik dalam fail pengendalian kod atau laluan direktori seperti fail atau dirName.

Tag

• Penamaan

Tahap

[x] Pemula

Penjanaan AI

Model AI mungkin lalai kepada nama samar-samar seperti fail atau dirName tanpa arahan khusus.

Menambah garis panduan penamaan deskriptif dan pengekstrakan kod boleh meningkatkan output AI.

Pengesanan AI

Alat AI boleh membetulkan bau ini dengan menggunakan konvensyen penamaan yang jelas dan mencadangkan pengekstrakan kod jika digesa untuk mengelakkan kod berlebihan.

Cuba Mereka!

Ingat: AI Assistants melakukan banyak kesilapan

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

Kesimpulan

Dengan menggunakan nama yang tepat seperti fileName dan directoryPath serta mengekstrak kaedah boleh guna semula, anda meningkatkan kejelasan dan kebolehselenggaraan kod.

Amalan mudah ini membantu mengurangkan lebihan dan memastikan kod anda dapat difahami.

perhubungan

Bau Kod 33 - Singkatan

Maxi Contieri ・ 24 Nov '20

#oop #codenewbie #pengaturcaraan #tutorial

Penafian

Bau Kod adalah pendapat saya.

Kredit

Foto oleh Gabriel Heinzer di Unsplash

---

Kod hendaklah ditulis untuk dibaca oleh manusia dahulu, dan kedua mesin.

Don Laabs

Petikan Hebat Kejuruteraan Perisian

Maxi Contieri ・ 28 Dis '20

#codenewbie #pengaturcaraan #quotes #perisian

---

Artikel ini adalah sebahagian daripada Siri CodeSmell.

Cara Mencari Bahagian Busuk Kod anda

Maxi Contieri ・ 21 Mei '21

#codenewbie #tutorial #codequality #pemula

Atas ialah kandungan terperinci Bau Kod - DirName dan Fail. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!