Có nên bình luận khác nhau trong các ngôn ngữ chức năng? [đóng cửa]

Tôi mới bắt đầu với lập trình chức năng và tôi đang tự hỏi về cách chính xác để nhận xét mã của mình.

Có vẻ hơi dư thừa để bình luận một chức năng ngắn vì tên và chữ ký đã cho bạn biết mọi thứ bạn cần biết. Nhận xét các chức năng lớn hơn cũng có vẻ hơi dư thừa vì chúng thường bao gồm các chức năng tự mô tả nhỏ hơn.

Cách chính xác để bình luận một chương trình chức năng là gì? Tôi có nên sử dụng cách tiếp cận tương tự như trong lập trình lặp không?

Tên hàm sẽ cho biết bạn đang làm gì.

Việc thực hiện sẽ cho bạn biết bạn đang làm như thế nào .

Sử dụng ý kiến ​​để giải thích lý do tại sao bạn làm điều đó.

Chắc chắn có một điểm trong câu hỏi này, vì các chương trình chức năng thường ở một mức độ trừu tượng khác với các mệnh lệnh bắt buộc.

Bởi vì điều này, một phong cách khác của tài liệu là cần thiết. Trong các chương trình lặp, một nhận xét có thể hữu ích như trong đoạn mã sau, bởi vì bản chất của mã được ẩn đằng sau bản tóm tắt:

// map 'toUpperCase' over 'container' yielding 'result'
Container result = new Container();
for (int i=0; i < container.size(); i++) { 
             result.addToTail(container.atElement(i).toUpperCase());
}

Nhưng điều này rõ ràng là vô nghĩa trong một ngôn ngữ chức năng:

-- map 'toUpperCase' over 'list'
let result = map toUpperCase list

Tốt hơn:

-- we need the FooBars in all uppercase for the Frobnitz-Interface
let result = map toUpperCase list

Lý do chúng tôi ghi lại một chức năng là người đọc không muốn hoặc không thể đọc phần thân của chức năng. Vì lý do này, người ta nên ghi lại các chức năng lớn, ngay cả trong các ngôn ngữ chức năng. Không có vấn đề gì nếu nó dễ hiểu chức năng làm gì bằng cách xem xét triển khai của nó.

Các hàm nên được nhận xét, nếu chỉ riêng tên hàm và tên tham số không đủ để chỉ định hợp đồng .

// returns a list of Employees    <-- not necessary
def GetEmployeeList: ...

// returns a list of Employees sorted by last name    <-- necessary
def GetEmployeeList: ...

Tóm lại, hợp đồng xác định chức năng mong đợi và những gì nó đảm bảo. Nói một cách chính xác, nếu GetEmployeeListtrả về một danh sách đã được sắp xếp nhưng không nói như vậy trong tên hàm hoặc nhận xét, người tiêu dùng của chức năng này không được dựa vào hành vi này. Đó là một chi tiết triển khai không có giấy tờ và tác giả GetEmployeeListcó quyền tự do thay đổi hành vi này bất cứ lúc nào.

Bản thân nhận xét không nên chứa một mô tả thay thế cho những gì mã thực hiện (mà thực sự được thể hiện bằng chính mã), mà là giải thích về lý do tại sao mã được viết theo cách của nó.

Điều đó nói rằng, tôi không thấy bất kỳ lý do tại sao một bình luận nên mỗi gia nhập thể khác nhau trong một ngôn ngữ chức năng.

Tôi có cùng một cách tiếp cận để ghi lại tất cả các mã của mình:

• Sử dụng tên mô tả,
• Thêm nhận xét trước bất kỳ logic phức tạp hợp lý nào nếu logic phức tạp không thể tránh được,
• Viết tổng quan về toàn bộ hệ thống,

Nếu tên và loại chữ ký không cho bạn biết chính xác chức năng đó là gì, thì bạn thường làm sai.

Ở tuổi 25 bạn có xu hướng nhớ mọi thứ tốt hơn nhiều. Khi bạn già đi và bạn tham gia vào nhiều hệ thống với mã kế thừa (vâng, mã bạn viết hôm nay sẽ là mã kế thừa trong vòng 10 - 15 năm), nó có thể rất hữu ích nếu có ý kiến.