Are code comments useful?
What source code comments do we mean?

We are interested in your opinion on non-public prologue code comments, that tell you what a piece of code does so that you do not have to read the actual code. We do not mean code that is released as a public API.

Example:

/**
  * Registers the text to display in a tool tip.   The text
  * displays when the cursor lingers over the component.
  */
 public void setToolTipText(String text) {...}

These are comments written before: modules/packages, classes, functions/methods or attributes but <b>not</b> in inline comments that explain what single statements do.


Counter-example:

/* process each element's data */
updatePattern(i, returnedElements[i]);


We are grateful for the time you invest into our questionnaire.
Sign in to Google to save your progress. Learn more
Please answer the questions according to your personal experiences and attitudes towards code comments.
1. How often do you read documentation in the form of prologue code comments (see introduction, we do not mean published API documentation, but inernally documented code)?
Clear selection
2. For what parts of your source code do you write prologue comments (as specified in the introduction)?
3.  How often are you in a situation where prologue comments are mandatory (i.e. through coding guidelines)?
Clear selection
4. Do you think prologue comments are useful or not?
Clear selection
5. When writing code, I tend to write prologue comments (as specified in the introduction) into it:
Clear selection
6.In the majority of cases prologue comments  helped me understand code I had to read:
Clear selection
7.I think prologue comments are important in this part of the code, when writing code that another developer is going to read in the future:
Completely disagree
Disagree
Neither agree nor disagree
Agree
Completely agree
Modules
Interfaces
Classes
Method/Functions
Attributes
Clear selection
8.I think prologue code comments are important for the readability of the code, when writing code that another developer is going to read in the future:
Clear selection
9. I think the importance of prologue comments increases with increasing complexity of the software.
Clear selection
10. Do you think there are alternatives to documentation with prologue code comments?
(Can be left blank)
In order to allow us to classify the results, please tell us something about your professional background.
11. What is your current occupation?
12. How much work experience in software development do you have?
This includes any work in a professional software development environment, including internships, side jobs and full jobs.
Clear selection
We thank you very much for your cooperation!
Optional: If you provide us with your email-adress, we would be happy to send you the results of this survey.
Submit
Clear form
Never submit passwords through Google Forms.
This content is neither created nor endorsed by Google. - Terms of Service - Privacy Policy

Does this form look suspicious? Report

Google Forms