Đang tải... (xem toàn văn)
mẫu biểu hướng dẫn quy trình phát triển phần mềm
hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.01Lần sửa đổi:0Ngày có hiệu lực: Bảng theo dõi thay đổi tài liệuSTT Vị trí sửa đổi Tóm tắt nội dung thay đổi Ghi chúNgời viết Ngời kiểm tra Phê duyệtHọ tênChữ ký hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.01Lần sửa đổi:0Ngày có hiệu lực: Tiêu chuẩn viết mã chơng trình phần mềm1. tổng quan1.1 Mục đíchTài liệu nêu các tiêu chuẩn về viết mã chơng trình phần mềm trong quá trình phát triển và xử lý lỗi phần mềm.1.2 Phạm vi áp dụngTài liệu sử dụng cho các quản trị dự án, lập trình và kiểm tra chất lợng phần mềm.2. nội dung2.1 Các quy định chunga) Trách nhiệm ngời thực hin- Quản trị dự án, các nhóm trởng lập trình có trách nhiệm phổ biến cho các lập trình viên tham gia vào dự án. Các thành viên dự án phải có trách nhiệm tuân thủ những quy định đợc đặt ra trong quá trình phát triển và xử lý lỗi phần mềm và nhóm trởng phải kiểm tra.- Việc tuân thủ phải đợc vận dụng sao cho phù hợp với đặc điểm của ngôn ngữ, các công cụ phát triển.b) Ghi chú các thông tin chung- Tất cả những đoạn đầu chơng trình phải có những thông tin chung về mã nh:Ngày khởi tạoNgời viết codeNgày kiểm traNội dung của phần mã chơng trình. (đoạn mã này để làm gì)- Mỗi lần sửa mã phải thêm các thông tinLần sửaNgời sửaNgày sửaNội dung sửa- Trong mỗi đoạn phức tạp phải có các ghi chú để ngời đọc dễ hiểu, ngắn gọn, rõ ràng.2.2 Các quy định chi tiết2.2.1 Trình bày cấu trúcCấu trúc trình bày phải sáng sủa, mạch lạc. Tránh phức tạp hoá làm giảm tốc độ của chơng trình.Các đoạn chơng trình phải đợc trình bày một cách sáng sủa và có cấu trúc. Dòng lệnh ở cùng một mức phải đợc viết lùi ra lùi vào một khoảng cách giống nhau.2.2.2 Dòng lệnhKhông nên viết nhiều câu lệnh trên một dòng. hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.01Lần sửa đổi:0Ngày có hiệu lực: Nếu câu lệnh dài quá có thể xuống dòng để đọc đợc toàn câu lệnh trên màn hình. Luôn phải tuân thủ cách trình bày theo cấu trúc.2.2.3 Tên hằngTheo qui theo qui ớc mã nguồn đã thóng nhất vi dụ: Hằng tổng thể đặt tiếp đầu ngữ là pconst_, hằng cục bộ đặt const_.2.2.4 Tên biếnThống nhất chung về cách đặt tên biến theo qui ớc mã, tên biến phải mô phỏng đợc chức năng của biến. Ví dụ biến tổng thể tiếp đầu ngữ là pv_, ví dụ tạo biến connection tổng thể thì có thể đặt tên là pv_conn. Biến cục bộ chỉ cần mô phỏng đợc chức năng của biến. Tên biến đặt nên có nghĩa nhng không nên đặt quá dài. 2.2.5 Tên hàmThống nhất cách đặt tên hàm. Ví dụ hàm tổng thể đặt tiếp đầu ngữ là pf_ sau đó là tên hàm có nghĩa. Hàm cục bộ tiếp đầu ngữ chỉ có f_.Thống nhất cách đặt tên thủ tục. Thủ tục tổng thể đặt tiếp đầu ngữ là pp_ sau đó là tên hàm có nghĩa. Thủ tục cục bộ tiếp đầu ngữ chi có p_.Tên hàm, thủ tục có nghĩa nhng không nên quá dài.2.2.6 Tên các đối tợng khácTên các đối tợng phải thống nhất, và phải phân biệt nhau. Tuỳ theo đặc điểm từng ngôn ngữ để tuân theo bộ công cụ phát triển. Một vài ví dụ có thể sử dụng, trờng hợp nào cha đợc liệt kê ra sau đây có thể nhóm trởng cho thống nhất trong nhóm. Ví dụ:Tên form: frm_ tiếp sau là tên form có nghĩa.Tên report: rpt_ tiếp sau là tên report có nghĩa.Tên menu: mnu_ tiếp sau là tên menu có nghĩa.Tên các textbox: txt_ tiếp sau là tên textbox có nghĩa.Tên các combobox: cmb_ tiếp sau là tên combobox có nghĩa .2.2.7 Tên file phần mềmPhải tuân thủ các nguyên tắc sau:- Tuân theo nguyên tắc đặt tên file do hệ điều hành qui định- Phù hợp với nội dung thiết kế và công cụ phát triển- Tuẩn thủ các quy định nêu ra ở trên . viết mã chơng trình phần mềm trong quá trình phát triển và xử lý lỗi phần mềm. 1 .2 Phạm vi áp dụngTài liệu sử dụng cho các quản trị dự án, lập trình và kiểm. rõ ràng .2. 2 Các quy định chi tiết2 .2. 1 Trình bày cấu trúcCấu trúc trình bày phải sáng sủa, mạch lạc. Tránh phức tạp hoá làm giảm tốc độ của chơng trình. Các