Arti Blok Code Comment pada STM32

Blok kode tersebut adalah bagian dari template file yang dihasilkan oleh STM32CubeMX atau IDE terkait, seperti STM32CubeIDE. Penjelasan rinci setiap bagian adalah sebagai berikut:

1. /* USER CODE BEGIN PFP */ dan /* USER CODE END PFP */

• PFP: Singkatan dari Private Function Prototypes.
• Bagian ini digunakan untuk menuliskan deklarasi (prototype) fungsi yang akan Anda definisikan sendiri.
• Semua kode yang ditulis di dalam blok ini tidak akan dihapus ketika file di-generate ulang oleh STM32CubeMX.

Contoh Penggunaan:

Jika Anda ingin mendeklarasikan fungsi pribadi sebelum digunakan dalam file, tuliskan di bagian ini:

/* USER CODE BEGIN PFP */
void myCustomFunction(void);
/* USER CODE END PFP */

Fungsi myCustomFunction() dapat diimplementasikan di bagian lain, misalnya di /* USER CODE BEGIN 0 */.

2. /* Private user code --------------------------------------------------------- */

• Bagian ini adalah tempat untuk menambahkan kode spesifik pengguna.
• Biasanya mencakup inisialisasi tambahan, fungsi, atau implementasi algoritma sesuai kebutuhan.

Sub-blok:

(a) /* USER CODE BEGIN 0 */ dan /* USER CODE END 0 */

• Tempat untuk mendefinisikan fungsi, variabel global, atau kode inisialisasi tambahan.
• Kode yang ditambahkan di sini akan tetap ada meskipun file di-generate ulang.

(b) Kode di luar blok komentar

• Hindari menambahkan kode di luar blok USER CODE, karena akan dihapus jika file di-generate ulang.

Contoh Penggunaan:

Implementasi fungsi yang dideklarasikan di /* USER CODE BEGIN PFP */:

/* USER CODE BEGIN 0 */
void myCustomFunction(void) {
    HAL_GPIO_TogglePin(GPIOB, GPIO_PIN_0);
}
/* USER CODE END 0 */

Cara Penggunaan Blok USER CODE

1. Menambahkan Fungsi Pribadi:

   • Deklarasikan di /* USER CODE BEGIN PFP */.
   • Implementasikan di /* USER CODE BEGIN 0 */.

2. Kode Inisialisasi Tambahan:

   • Letakkan inisialisasi perangkat keras atau variabel di /* USER CODE BEGIN 0 */.

3. Pastikan Konsistensi:

   • Hindari mengedit kode di luar blok USER CODE, karena akan hilang saat file di-generate ulang.

Keuntungan Menggunakan Blok USER CODE

• Perlindungan Kode: STM32CubeMX tidak akan menghapus kode Anda saat file di-generate ulang.
• Organisasi yang Rapi: Memisahkan kode pengguna dari kode auto-generated membuat pemeliharaan lebih mudah.
• Flexibilitas: Memungkinkan Anda untuk menyesuaikan dan memperluas fungsionalitas template dasar.