Compile Comment Title For Free

File Headers Your comment header should include at least your name, course/section, date, and a brief description of the assignment. If the assignment asks you to submit multiple files, each file's comment header should describe that file/class and its main purpose in the program.

In this post: Read the blog post before commenting. Read the other comments before asking a question. Don't leave spammy links. Don't share a link to a blog post on the exact topic. Use one-liners sparsely. You don't need to write a novella in the comments. Try to be specific in your comments. Address the writer by their name.

How to comment Code: Primarily, a single "block" comment should be placed at the top of the function (or file) and describe the purpose the code and any algorithms used to accomplish the goal. In-line comments should be used sparingly, only where the code is not "self-documenting".

Every header should include: A brief description of the file. A detailed description of the file. Author's name. The date of first release. The developer's name, date and a description of each revision. Perhaps a line or two about licensing.

Top ten tips for writing a great comment Read the article. ... Respond to the article. ... Read the other comments. ... Make it clear who you're replying to. ... Use the return key. ... Avoid sarcasm. Avoid unnecessary acronyms. Use facts.

12 Tips for Writing an Awesome Comment Read the blog post before commenting. ... Read the other comments before asking a question. ... Don't leave spammy links. ... Don't share a link to a blog post on the exact topic. ... Use one-liners sparsely. ... You don't need to write a novella in the comments. ... Try to be specific in your comments.

'I'm always happy with new developments,' he commented. Stuart commented that this was very true. He made his comments at a news conference in Amsterdam. I was wondering whether you had any comments about that?