2.2.4.1.Tài liệu chơng trình:

Một phần của tài liệu Xây dựng phần mềm hỗ trợ bầu cử và quản lí cổ đông, cổ tức , CTCP Naphaco (Trang 33 - 34)

Tài liệu bên trong của chơng trình gốc bắt đầu với việc chọn lựa các tên gọi định danh (biến và nhãn), tiếp tục với vị trí và thành phần của việc chú thích, và kết luận với cách tổ chức trực quan của chơng trình. Việc lựa chọn các tên gọi định danh có nghĩa là điều chủ chốt cho việc hiểu chơng trình. Những ngôn ngữ giới hạn độ dài tên biến hay nhãn làm các tên mang nghĩa mơ hồ. Cho dù một chơng trình nhỏ thì một tên có ý nghĩa làm “ đơn giản hoá việc chuyển đổi từ cú pháp chơng trình sang cấu trúc ngữ nghĩa bên trong”. Một điều rõ ràng là: phần mềm phải chứa tài liệu bên trong. Lời chú thích cung cấp cho ngời phát triển một ý nghĩa truyền thông với các độc giả khác về chơng trình gốc. Lời chú thích có thể cung cấp một hớng dẫn rõ rệt để hiểu trong bớc cuối cùng của kỹ nghệ phần mềm - bảo trì, nhất là những phần mềm quản lý nh quản lý cổ đông, cổ tức cần đợc nâng cấp bảo trì thờng xuyên để đáp ứng sự thay đổi của thực tế. Có nhiều h- ớng dẫn đã đợc đề nghị cho việc viết lời chú thích. Các chú thích mở đầu và chú thích chức năng là hai phạm trù đòi hỏi cách tiếp cận có hơi khác [14].

chú thích nh thế là:

1. Một phát biểu về mục đích chỉ rõ chức năng module. 2. Mô tả giao diện bao gồm:

Một mẫu cách gọi Mô tả về dữ liệu

Danh sách tất cả các module thuộc cấp.

3. Thảo luận về dữ liệu thích hợp (nh các biến quan trọng và những hạn chế, giới hạn về cách dùng chúng) và các thông tin quan trọng khác.

4. Lịch sử phát triển module bao gồm: Tên ngời thiết kế module (tác giả) Tên ngời xét duyệt và ngày tháng. Ngày tháng sửa đổi và mô tả sửa đổi.

Các chú thích chức năng đợc nhúng vào bên trong thân của chơng trình gốc và đợc dùng để mô tả cho các khối chơng trình.

Một phần của tài liệu Xây dựng phần mềm hỗ trợ bầu cử và quản lí cổ đông, cổ tức , CTCP Naphaco (Trang 33 - 34)