8. Documenting

Question 1

What are two types of documentation you can make to help others understand your program?

Answer 1

Comments and README files

Question 2

Which type of documentation helps you remember what small chunks of code are supposed to do?

Answer 2

Comments attached to lines of code

Question 3

Why is “commenting out” a line of code helpful in debugging?

Answer 3

It helps you prevent small chunks of the program from running without having to delete them, so you attach a comment to that line of code and it will still be with the code but the computer will not read it as part of the program

Question 4

Why are comments useful to you and other programmers?

Answer 4

If you har working on a project with others, its much easier to read a comment explaining a chunk of code than it is to try to read the code itself if you didn’t write it yourself

Question 5

If you wanted to add a note/comment in your code as a reminder to come back and fix it you could name it ____

Answer 5

BUG or #FIXME

Question 6

Which of the following would you use to help a user install your program: a README file or a comment in your code?

Answer 6

README file

Question 7

What is a userguide?

Answer 7

A user guide is a document that helps the user learn the functionality of a program