When creating a private or protected variable, method, class, etc., should it be commented with the documentation comment?
When creating a private or protected variable, method, class, etc., should it be commented
Share
Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
When creating a private or protected variable, method, class, etc., should it be commented with the documentation comment?
Yes! The comments are to help any developer – yourself included – when reviewing, maintaining or extending the code in future. Whether it’s public/private shouldn’t be an influencing factor, quite simply if you think something isn’t clear enough without a comment, put one in.
(Of course the best documentation is clear self-documenting code in the first place)