Apakah peraturan untuk menamakan pembolehubah dan folder?

Penamaan pembolehubah dan folder dalam projek adalah sangat penting untuk mengekalkan kebolehbacaan dan keteraturan kod. Berikut ialah beberapa konvensyen dan peraturan penamaan umum:

Menamakan pembolehubah

1. Gunakan camelCase: untuk pembolehubah, fungsi dan nama prop atau pembolehubah keadaan, seperti:

   • Nama pengguna
   • sedangLoggedMasuk
   • tanganKlik

2. Namakan dengan jelas: Nama pembolehubah harus jelas menyampaikan fungsinya atau maklumat yang dipegangnya, contohnya:

   • cartItems (untuk item dalam troli)
   • authToken (untuk token pengesahan)

3. Gunakan nama deskriptif untuk jenis data: Jika terdapat berbilang jenis data dalam pembolehubah yang sama, contohnya:

   • umur pengguna (jika terdapat berbilang pembolehubah tentang pengguna)
   • harga produk

4. Elakkan singkatan: Gunakan nama penuh untuk kejelasan, contohnya:

   • Gunakan userProfile dan bukannya usrProf.

Penamaan folder

1. Gunakan kebab-case atau snake_case: untuk nama folder, contohnya:

   • profil pengguna (sarung kebab)
   • profil_pengguna (snake_case)

2. Namakan secara deskriptif: Nama folder harus menggambarkan kandungan atau fungsinya, contohnya:

   • komponen/ (untuk menyimpan komponen React)
   • services/ (untuk menyimpan fungsi perkhidmatan atau API)
   • cangkuk/ (untuk menyimpan cangkuk tersuai)

3. Gunakan format yang konsisten: Kekalkan format penamaan yang konsisten merentas projek. Untuk tempahan, seperti:

   • Jika menggunakan kebab-case untuk folder Gunakan format yang sama untuk semua folder

4. Elakkan nama generik atau samar-samar: Gunakan nama yang menggambarkan kandungan atau fungsi folder, seperti:

   • Gunakan utils/ bukannya misc/
   • Gunakan kedai/ bukannya data/

contoh

Folder:

src/
├── components/
│   ├── Button.tsx
│   └── Header.tsx
├── hooks/
│   └── useFetch.ts
├── services/
│   └── apiService.ts
├── stores/
│   ├── auth/
│   │   ├── useAuthStore.ts
│   │   └── authTypes.ts
│   ├── user/
│   │   ├── useUserStore.ts
│   │   └── userTypes.ts
│   ├── product/
│   │   ├── useProductStore.ts
│   │   └── productTypes.ts
│   └── cart/
│       ├── useCartStore.ts
│       └── cartTypes.ts
└── index.ts

Pembolehubah:

// ตัวอย่างใน useAuthStore.ts
interface AuthState {
  isAuthenticated: boolean;
  user: string | null;
  login: (username: string) => void;
  logout: () => void;
}

// ตัวอย่างใน useUserStore.ts
interface UserState {
  name: string;
  email: string;
  updateUser: (name: string, email: string) => void;
}

Menggunakan peraturan penamaan yang baik akan membantu kod anda kelihatan teratur dan lebih mudah difahami

Menamakan nilai konfigurasi atau pemalar seperti PANGKALAN DATA_CONFIG Prinsip harus diikuti yang memudahkan pemahaman dan memenuhi objektif. Berikut ialah peraturan untuk menamakan konfigurasi:

กฎในการตั้งชื่อค่าคอนฟิก

1. ใช้รูปแบบ UPPER_SNAKE_CASE: ชื่อของค่าคอนฟิกหรือค่าคงที่ควรใช้รูปแบบ UPPER_SNAKE_CASE เพื่อแสดงให้เห็นว่านี่คือค่าคงที่และไม่ควรถูกเปลี่ยนแปลง เช่น:

   • DATABASE_CONFIG
   • API_ENDPOINT
   • MAX_RETRY_ATTEMPTS

2. สื่อความหมายได้ชัดเจน: ชื่อของค่าคอนฟิกควรบ่งบอกถึงการใช้งานหรือวัตถุประสงค์ของมัน เช่น:

   • DATABASE_HOST (สำหรับโฮสต์ของฐานข้อมูล)
   • CACHE_EXPIRATION_TIME (สำหรับเวลาหมดอายุของแคช)

3. รวมคอนเท็กซ์และการใช้งาน: ค่าคอนฟิกควรมีชื่อที่รวมคอนเท็กซ์หรือการใช้งานเพื่อให้เข้าใจได้ง่าย เช่น:

   • EMAIL_SERVICE_API_KEY (สำหรับคีย์ API ของบริการอีเมล)
   • JWT_SECRET_KEY (สำหรับคีย์ลับของ JSON Web Token)

4. หลีกเลี่ยงการใช้ชื่อที่คลุมเครือ: ชื่อของค่าคอนฟิกควรเฉพาะเจาะจงและไม่ควรใช้ชื่อที่คลุมเครือหรือทั่วไปเกินไป เช่น:

   • ใช้ DATABASE_PORT แทน PORT
   • ใช้ SESSION_TIMEOUT แทน TIMEOUT

5. ใช้คำที่สื่อถึงประเภทของค่า: ชื่อค่าคอนฟิกควรสื่อถึงประเภทของค่า เช่น ค่าเชิงตัวเลข, สตริง, หรือ Boolean เป็นต้น เช่น:

   • MAX_CONNECTIONS (ค่าตัวเลขสูงสุดของการเชื่อมต่อ)
   • ENABLE_LOGGING (ค่า Boolean สำหรับเปิดหรือปิดการบันทึก)

ตัวอย่างการตั้งชื่อค่าคอนฟิก

ไฟล์คอนฟิก

// ตัวอย่างในไฟล์ config.ts

export const DATABASE_CONFIG = {
  HOST: 'localhost',
  PORT: 5432,
  USER: 'dbuser',
  PASSWORD: 'password',
  DATABASE_NAME: 'mydatabase'
};

export const API_CONFIG = {
  BASE_URL: 'https://api.example.com',
  TIMEOUT: 5000, // Timeout in milliseconds
  API_KEY: 'your-api-key-here'
};

export const APP_SETTINGS = {
  MAX_RETRY_ATTEMPTS: 3,
  SESSION_TIMEOUT: 3600, // Timeout in seconds
  ENABLE_LOGGING: true
};

การใช้ค่าคอนฟิกในโค้ด

import { DATABASE_CONFIG, API_CONFIG, APP_SETTINGS } from './config';

// การใช้ค่าคอนฟิกในการเชื่อมต่อฐานข้อมูล
const dbConnection = connectToDatabase({
  host: DATABASE_CONFIG.HOST,
  port: DATABASE_CONFIG.PORT,
  user: DATABASE_CONFIG.USER,
  password: DATABASE_CONFIG.PASSWORD,
  database: DATABASE_CONFIG.DATABASE_NAME
});

// การใช้ค่าคอนฟิกสำหรับ API
const fetchData = async () => {
  try {
    const response = await fetch(API_CONFIG.BASE_URL + '/data', {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${API_CONFIG.API_KEY}`
      },
      timeout: API_CONFIG.TIMEOUT
    });
    const data = await response.json();
    return data;
  } catch (error) {
    if (APP_SETTINGS.ENABLE_LOGGING) {
      console.error('Error fetching data:', error);
    }
    throw error;
  }
};

การใช้หลักการเหล่านี้จะช่วยให้คุณตั้งชื่อค่าคอนฟิกอย่างมีระเบียบและเข้าใจง่ายครับ

Atas ialah kandungan terperinci Apakah peraturan untuk menamakan pembolehubah dan folder?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!