What are the rules for naming variables and folders?

Naming for variables and folders in a project is very important for maintaining readability and order in the code. Here are some general naming conventions and rules:

Naming variables

1. Use camelCase: for variables, functions, and names of props or state variables, such as:

   • userName
   • isLoggedIn
   • handleClick

2. Nam it clearly: The name of a variable should clearly convey its function or the information it stores. For example:

   • cartItems (for items in the cart)
   • authToken (for authentication token)

3. Use a descriptive name for the data type: If there are multiple data types in the same variable, for example:

   • userAge (if there are many types of variables about the user)
   • productPrice

4. Avoid abbreviations: Use full names for clarity, such as:

   • Use userProfile instead of usrProf.

Folder naming

1. Use kebab-case or snake_case: for the name of the folder, for example:

   • user-profile (kebab-case)
   • user_profile (snake_case)

2. Make a descriptive name: The name of a folder should reflect its contents or functionality, for example:

   • components/ (for storing React components)
   • services/ (for storing service functions or API)
   • hooks/ (for storing custom hooks)

3. Use a consistent format: Maintain a consistent naming format across projects. For orderliness, such as:

   • If using kebab-case for a folder Use the same format for all folders

4. Avoid generic or vague names: Use names that are descriptive of the folder's contents or function, such as:

   • Use utils/ instead of misc/
   • Use store/ instead of data/

example

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

Variables:

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

Using good naming rules will help your code look organized and easier to understand

Naming configuration values or constants, e.g. DATABASE_CONFIG Principles that are easy to understand and objective should be followed. Here are the rules for naming configurations:

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

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

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

The above is the detailed content of What are the rules for naming variables and folders?. For more information, please follow other related articles on the PHP Chinese website!