變數和資料夾的命名規則是什麼？

專案中變數和資料夾的命名對於維護程式碼的可讀性和順序非常重要。以下是一些通用命名約定和規則：

命名變數

1. 使用駝峰命名法：用於變數、函數以及 props 或狀態變數的名稱，例如：

   • 使用者名稱
   • 已登入
   • 處理點擊

2. 命名清楚：變數的名稱應該清楚地傳達它的功能或它所保存的訊息，例如：

   • cartItems（購物車中的商品）
   • authToken（用於身份驗證令牌）

3. 對資料類型使用描述性名稱：如果同一個變數中有多種資料類型，例如：

   • userAge（如果有關於使用者的多個變數）
   • 產品價格

4. 避免縮寫：為了清晰起見，使用全名，例如：

   • 使用 userProfile 而不是 usrProf。

資料夾命名

1. 使用kebab-case或snake_case：作為資料夾的名稱，例如：

   • 使用者個人資料（kebab-case）
   • 使用者個人資料 (snake_case)

2. 描述性命名：資料夾的名稱應反映其內容或功能，例如：

   • Components/（用於儲存React元件）
   • services/（用於儲存服務函數或API）
   • hooks/ （用於儲存自訂鉤子）

3. 使用一致的格式：跨項目保持一致的命名格式。如需訂購，例如：

   • 如果對資料夾使用 kebab-case對所有資料夾使用相同的格式

4. 避免通用或模糊的名稱：使用反映資料夾內容或功能的名稱，例如：

   • 使用utils/代替misc/
   • 使用 store/ 取代 data/

例子

資料夾：

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

變數：

// ตัวอย่างใน 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;
}

使用良好的命名規則將幫助您的程式碼看起來更有條理且更易於理解

命名配置值或常數，例如資料庫配置應遵循易於理解和實現目標的原則。以下是命名配置的規則：

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

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

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

以上是變數和資料夾的命名規則是什麼？的詳細內容。更多資訊請關注PHP中文網其他相關文章！