วัตถุประสงค์ของการเขียน
ข้อกำหนดนี้กำหนดไฟล์โปรแกรมและรูปแบบการเขียนโค้ดที่เกี่ยวข้องกับกระบวนการเขียนโปรแกรม ข้อมูลจำเพาะนี้ได้รับการพัฒนาตามภาษา Delphi
การจัดเอกสารโครงการ
ใน Delphi ไฟล์โปรแกรมจะถูกจัดเรียงตามหน่วยโครงการ ในโครงการทั่วไปได้แก่:
ไฟล์โครงการ (ไฟล์ .DRP)
มีซอร์สโค้ด Pascal ของโปรแกรมหลักของโครงการ
ไฟล์หน่วย (ไฟล์ .PAS)
ไฟล์ต้นฉบับ Pascal สำหรับแต่ละแบบฟอร์มในโครงการ รวมถึงการประกาศและขั้นตอนทั้งหมดของแบบฟอร์ม (รวมถึงขั้นตอนการประมวลผลเวลา)
ไฟล์ฟอร์ม (ไฟล์ .DFM)
ไฟล์ไบนารีที่มีคุณสมบัติการออกแบบของแบบฟอร์ม ไฟล์ .DFM และไฟล์ .PAS ของแต่ละแบบฟอร์มจะสอดคล้องกัน
ไฟล์ทรัพยากร (ไฟล์ .RES)
ไฟล์ทรัพยากรไบนารีที่คอมไพล์ซึ่งเชื่อมโยงเข้ากับไฟล์ปฏิบัติการของแอปพลิเคชัน
ไฟล์ตัวเลือกโครงการ (ไฟล์ .DOF)
จัดเก็บตัวเลือกโครงการที่กำหนดโดยคำสั่งเมนู PProject|Options
ไฟล์การตั้งค่าเดสก์ท็อป (ไฟล์ .DSK)
จัดเก็บตัวเลือกเดสก์ท็อปที่กำหนดโดยคำสั่งเมนูเครื่องมือ | ตัวเลือก
ไฟล์แพ็คเกจ (ไฟล์ .DPK/.BPL)
ไฟล์ที่ใช้ในการแชร์ส่วนประกอบ คลาส ข้อมูล และโค้ด ไฟล์ต้นฉบับเป็นไฟล์ .DPK และหลังจากการคอมไพล์แล้วจะเป็นไฟล์ .BPL
คำจำกัดความคงที่
เนื้อหา:
คำจำกัดความของค่าตรรกะ
คำจำกัดความของค่าคงที่
คำจำกัดความของรหัสข้อผิดพลาด
รูปแบบ: หนึ่งคำจำกัดความต่อบรรทัด ดังต่อไปนี้:
ค่าคงที่ <คงที่>: type = value; //Comment
แสดงให้เห็น:
ใช้คำสั่ง Const เพื่อประกาศค่าคงที่ที่ใช้แทนค่าตามตัวอักษร
ตัวอย่าง: Const C_SQL:string='select CH_USERER_ID จาก T_CD_USER'; //สอบถาม ID ผู้ใช้
Const C_PI:จริง =3.1415926; //Pi
คำจำกัดความประเภทโครงสร้าง
เนื้อหา: คำจำกัดความประเภทโครงสร้าง
รูปแบบ:
พิมพ์
<พิมพ์ชื่อ>//คำอธิบายคำอธิบายโครงสร้าง
<ชื่อตัวแปร 1>: ประเภทตัวแปร; // ความคิดเห็นเกี่ยวกับคำอธิบายตัวแปร
<ชื่อตัวแปร 2>: ประเภทตัวแปร; // ความคิดเห็นเกี่ยวกับคำอธิบายตัวแปร
-
จบ;
แสดงให้เห็น:
<ชื่อประเภท> คือสตริงที่ขึ้นต้นด้วยอักษรตัวพิมพ์ใหญ่ คำสั่งที่กำหนดประเภทตัวแปรในคำจำกัดความของโครงสร้างเริ่มต้นในแถวที่สองและคอลัมน์ที่ห้า
ตัวอย่าง:
พิมพ์
TableList=record //คำจำกัดความประเภทหน่วยแผนผังระบบ
InID: จำนวนเต็ม; //หมายเลขหน่วย
ชื่อ: string; //ชื่อหน่วย
PID: string; // ชื่อหน่วยก่อนหน้า
PT: PTableList; //ชี้ไปยังประเภทหน่วยถัดไป
จบ;
สไตล์การเขียนโปรแกรม
รูปแบบการเขียนโปรแกรมจะระบุกฎการวางตำแหน่งสำหรับแต่ละคำสั่งและความคิดเห็นในโปรแกรม
ลักษณะการทำงาน/ขั้นตอน
<function/procedure> ชื่อ (ตัวแปร: ประเภทตัวแปร [,...]);//คำอธิบายฟังก์ชัน/ขั้นตอน
var
ตัวแปร 1: ประเภทตัวแปร // คำอธิบายตัวแปร
ตัวแปร 2: ประเภทตัวแปร // คำอธิบายตัวแปร
-
เริ่ม
คำแถลง;
คำแถลง;
-
จบ ;
หมายเหตุ: การประกาศตัวแปรและคำสั่งจะถูกเขียนโดยเริ่มจากคอลัมน์ที่สาม หากมีการเยื้อง ให้เยื้องทีละสองคอลัมน์และจัดแนวให้สอดคล้องกับข้อความสั่งที่เกี่ยวข้อง
สไตล์คำสั่ง
แสดงให้เห็น:
โดยปกติจะมีคำอธิบายฟังก์ชันหนึ่งย่อหน้าสำหรับทุกๆ สิบบรรทัด มากที่สุดในเนื้อหาของโปรแกรม
สร้างมาตรฐานการใช้คำสั่งต่างๆ
การเยื้องในคำสั่งจะอยู่ในหน่วยของสองคอลัมน์
คำสั่งนิยามตัวแปร
var
var_name: <ชนิดข้อมูล>;
คำชี้แจงการมอบหมาย
var_name: = <นิพจน์>;
คำสั่งแบบมีเงื่อนไข
ถ้าเงื่อนไขแล้ว //แสดงความคิดเห็น
เริ่ม
คำแถลง;
-
จบ
อย่างอื่นถ้าเงื่อนไขแล้ว//แสดงความคิดเห็น
เริ่ม
คำแถลง;
-
จบ
อย่างอื่น//แสดงความคิดเห็น
คำแถลง;
หมายเหตุ: หากมีคำสั่งดำเนินการเพียงคำสั่งเดียว สามารถละเว้นคำสั่งเริ่มต้นและคำสั่งสิ้นสุดได้
คำสั่งวนซ้ำ
//คำอธิบายประกอบฟังก์ชันวนรอบ
สำหรับตัวนับ := เริ่มจนจบทำ
เริ่ม
[คำแถลง];
-
จบ;
//คำอธิบายประกอบฟังก์ชันวนรอบ
ในขณะที่ [เงื่อนไข] ทำ
เริ่ม
[คำแถลง];
-
จบ;
//คำอธิบายประกอบฟังก์ชันวนรอบ
ทำซ้ำ
[คำแถลง];
-
จนกระทั่ง [เงื่อนไข]
คำสั่งสลับ
//สลับคำอธิบายฟังก์ชัน
กรณี <การแสดงออก> ของ
<value1>:[คำสั่ง 1];
<value2>:[คำสั่ง 2];
-
<valuen>: [คำสั่ง n]
จบ;
คอมเม้นไลน์
จะต้องมีความคิดเห็น "คำอธิบายโมดูล" และ "คำอธิบายหน่วย" สำหรับไฟล์หน่วยนี้ที่ด้านบนของไฟล์หน่วยโค้ดโปรแกรม
สำหรับส่วนของโค้ดที่มีความหมาย เช่น ค่าคงที่ ประเภทโครงสร้าง ฟังก์ชัน/ขั้นตอน ตัวแปรที่กำหนดเอง บล็อกฟังก์ชันส่วนของโค้ด ข้อความสั่งหลัก ฯลฯ
ประเด็นจะต้องมีบรรทัดแสดงความคิดเห็นอธิบายอย่างละเอียด
บรรทัดความคิดเห็นสามารถเพิ่มด้วย "//XXXXXXXX" หลังบรรทัดที่ต้องอธิบาย หรืออาจเพิ่มไว้เหนือบรรทัดที่ต้องอธิบายก็ได้
เพิ่มหลายบรรทัดโดยใช้ "{XXXXXXXX}" หรือเพิ่มบรรทัดเดียวโดยใช้ "//XXXXXXX"
การตั้งชื่อไฟล์และแบบฟอร์ม
ความหมายรูปแบบการตั้งชื่อชั้น
ไฟล์โครงการ โปรแกรม (.DPR) XXXXX
หน่วยหน่วย(PAS) uXXXX
FormForm.Name(.DFM) XXXXXFrm
โมดูลข้อมูลDataModule XXXXXDM
คำจำกัดความส่วนหัวของหน่วย เพิ่มไว้ด้านหน้าแต่ละหน่วย
{************************************************ * ***
ชื่อยูนิต:
คำอธิบายฟังก์ชัน:
ผู้เขียน:
ชื่อซอฟต์แวร์:
เวอร์ชัน:
ชื่อบริษัท: Sword as Dream Software Creation Studio
************************************************** * *** }
คำจำกัดความรูปแบบหมายเลขเวอร์ชันซอฟต์แวร์:
ซอฟต์แวร์ใช้รูปแบบหมายเลขเวอร์ชันต่อไปนี้: XXXX
ตัวอย่างเช่น: หลังจากโปรแกรมที่วางจำหน่ายเสร็จสิ้น หมายเลขเวอร์ชันจะถูกทำเครื่องหมายเป็น "1.0.0.0"
ตัวเลขตัวแรก: หมายเลขเวอร์ชัน หมายเหตุ: นี่เป็นเวอร์ชันของซอฟต์แวร์ที่ได้รับการปรับปรุงอย่างมาก
หลักที่สอง: หมายเลขการบำรุงรักษา หมายเหตุ: ข้อผิดพลาดบางอย่างได้รับการแก้ไขตามเวอร์ชันที่มีอยู่
หลักที่สาม: หมายเลขแพทช์ หมายเหตุ: เมื่อโปรแกรมแก้ไขข้อผิดพลาดบางอย่างและไม่มีการสร้างหมายเลขการบำรุงรักษาใหม่ หมายเลขแพทช์จะถูกนำมาใช้
หลักที่สี่: หมายเลขแก้ไข หมายเหตุ: เมื่อเกิดข้อผิดพลาดของโปรแกรมฉุกเฉิน โปรแกรมที่แก้ไขจะถูกใช้เป็นตัวระบุ ไม่ใช่หมายเลขเวอร์ชันของโปรแกรมที่เผยแพร่ เย้ๆๆๆ