Tujuan penulisan
Spesifikasi ini mendefinisikan file program dan gaya pengkodean yang terlibat dalam proses penulisan program. Spesifikasi ini dikembangkan berdasarkan bahasa Delphi.
Organisasi dokumen proyek
Di Delphi, file program disusun menurut unit proyek. Dalam proyek tipikal meliputi:
File proyek (file .DRP)
Berisi kode sumber Pascal dari program utama proyek;
File unit (file .PAS)
File sumber Pascal untuk setiap formulir dalam proyek, termasuk semua deklarasi dan prosedur formulir (termasuk prosedur pemrosesan waktu);
File formulir (file .DFM)
File biner yang berisi properti desain formulir. File .DFM dan file .PAS dari setiap formulir berhubungan satu sama lain;
File sumber daya (file .RES)
File sumber daya biner yang dikompilasi yang ditautkan ke file aplikasi yang dapat dieksekusi;
File opsi proyek (file .DOF)
Menyimpan opsi proyek yang diatur oleh perintah menu PProject|Options;
File pengaturan desktop (file .DSK)
Menyimpan opsi desktop yang diatur oleh perintah menu Tools|Options;
File paket (file .DPK/.BPL)
File yang digunakan untuk berbagi komponen, kelas, data, dan kode. File sumber adalah file .DPK dan setelah dikompilasi menjadi file .BPL;
definisi konstan
isi:
Definisi nilai logika;
Definisi nilai konstan;
Definisi kode kesalahan;
Format: Satu definisi per baris. sebagai berikut:
Konstan<konstan>: tipe = nilai; //Komentar
menjelaskan:
Gunakan pernyataan Const untuk mendeklarasikan konstanta yang digunakan sebagai pengganti nilai literal.
Contoh: Const C_SQL:string='pilih CH_USERER_ID dari T_CD_USER'; //Kueri ID pengguna
Konstanta C_PI:nyata =3.1415926; //Pi
Definisi tipe struktur
Konten: Definisi tipe struktur
Format:
Jenis
<Ketik nama>//Komentar deskripsi struktur
<Nama variabel 1>: tipe variabel; //komentar deskripsi variabel
<Nama variabel 2>: tipe variabel; //komentar deskripsi variabel
…
Akhir;
menjelaskan:
<Jenis nama> adalah string yang dimulai dengan huruf besar. Pernyataan yang mendefinisikan tipe variabel dalam definisi struktur dimulai pada baris kedua dan kolom kelima.
Contoh:
jenis
TableList=record //Definisi tipe unit pohon sistem
InID: Integer; //nomor satuan
Nama: string; //Nama unit
PID: string; //Nama unit sebelumnya
PT: PTableList; //Menunjuk ke tipe unit berikutnya
akhir;
Gaya pemrograman
Gaya pemrograman menentukan aturan posisi untuk setiap pernyataan dan komentar dalam program.
Gaya fungsi/prosedur
<fungsi/prosedur> Nama (variabel: tipe variabel [,...]);//deskripsi fungsi/prosedur
var
Variabel 1: tipe variabel; // deskripsi variabel
Variabel 2: Jenis variabel; //Deskripsi variabel
…
mulai
penyataan;
penyataan;
…
akhir ;
Catatan: Deklarasi dan pernyataan variabel ditulis mulai dari kolom ketiga. Jika terdapat indentasi, indentasi sebanyak dua kolom sekaligus dan sejajarkan dengan pernyataan yang bersangkutan.
gaya pernyataan
menjelaskan:
Biasanya terdapat paling banyak satu paragraf deskripsi fungsi untuk setiap sepuluh baris di badan program;
Standarisasi penggunaan berbagai pernyataan;
Indentasi dalam pernyataan adalah dalam satuan dua kolom.
pernyataan definisi variabel
var
var_name: <tipe data>;
pernyataan tugas
var_name: = <ekspresi>;
pernyataan bersyarat
jika kondisi maka //Komentar
mulai
penyataan;
…
akhir
lain jika kondisi maka//komentar
mulai
penyataan;
...
akhir
lain//komentar
penyataan;
Catatan: Jika hanya ada satu pernyataan eksekusi, pernyataan awal dan akhir dapat dihilangkan.
Pernyataan lingkaran
//Anotasi fungsi loop
untuk counter := mulai sampai akhir lakukan
mulai
[penyataan];
…
akhir;
//Anotasi fungsi loop
sementara [kondisi] lakukan
mulai
[penyataan];
…
akhir;
//Anotasi fungsi loop
mengulang
[penyataan];
…
sampai [kondisi]
pernyataan peralihan
//ganti deskripsi fungsi
kasus <ekspresi> dari
<nilai1>:[pernyataan 1];
<nilai2>:[pernyataan 2];
…
<nilai>: [pernyataan n]
akhir;
Baris komentar
Harus ada komentar "Deskripsi Modul" dan "Deskripsi Unit" untuk file unit ini di bagian atas file unit kode program.
Untuk bagian kode yang bermakna seperti konstanta, tipe struktural, fungsi/prosedur, variabel khusus, blok fungsi segmen kode, pernyataan kunci, dll.
poin, harus ada baris komentar untuk menjelaskan secara detail.
Baris komentar dapat ditambahkan dengan "//XXXXXXXX" setelah baris yang perlu dijelaskan, atau dapat juga ditambahkan di atas baris yang perlu dijelaskan.
Tambahkan beberapa baris menggunakan "{XXXXXXXX}" atau tambahkan satu baris menggunakan "//XXXXXXXX".
Penamaan file dan formulir
Arti format penamaan nama kelas
File proyek Program(.DPR) XXXXX
SatuanUnit(PAS) uXXXXX
FormulirForm.Nama(.DFM) XXXXXFrm
Modul dataDataModule XXXXXDM
Definisi header unit, ditambahkan di depan setiap unit.
{******************************************************* ***
Nama satuan:
Deskripsi fungsi:
pengarang:
Nama perangkat lunak:
Versi:
Nama perusahaan: Sword as Dream Software Creation Studio
******************************************************* * *** }
Definisi format nomor versi perangkat lunak:
Perangkat lunak ini menggunakan format nomor versi berikut: XXXX
Misalnya: setelah program yang dapat dirilis selesai, nomor versi ditandai sebagai "1.0.0.0"
Digit pertama: nomor versi. Catatan: Ini adalah versi perangkat lunak yang telah ditingkatkan secara signifikan.
Digit kedua: Nomor pemeliharaan. Catatan: Beberapa kesalahan telah diubah berdasarkan versi yang ada.
Digit ketiga: nomor patch. Catatan: Ketika program memperbaiki beberapa kesalahan dan tidak ada nomor pemeliharaan baru yang terbentuk, nomor patch akan digunakan.
Digit keempat: nomor koreksi. Catatan: Ketika terjadi kesalahan program darurat, program yang dimodifikasi digunakan sebagai pengidentifikasi, bukan sebagai nomor versi program yang dirilis. yckxzjj