I know this post is ancient, but well formatted code never goes out of style. I use this template for all of my procedures. Some people don’t like verbose code and comments, but as someone who frequently has to update stored procedures that haven’t been touched since the mid 90s, I can tell you the … Read more
Do it like that: a, b, c, d = range(1, 5) result = ( # First is 1 a * # Then goes 2, result is 2 now b * # And then 3, result is 6 c * # And 4, result should be 24 d ) Actually, according to PEP8 parentheses are preferred … Read more
If it is needed to comment if else statements, I prefer to describe the case what made the code reach that point. Especially in code with a high cyclomatic complexity if (condition) { // User is taking a course at college x: i = 1; } else { // User is not taking any course … Read more
In Common Lisp: ;;;; At the top of source files ;;; Comments at the beginning of the line (defun test (a &optional b) ;; Commends indented along with code (do-something a) ; Comments indented at column 40, or the last (do-something-else b)) ; column + 1 space if line exceeds 38 columns Note: Emacs doesn’t … Read more
There is no difference as far as the interpreter is concerned. Think of ; ;; ;;; and ;;;; as different heading levels. Here is my personal use convention: ;;;; Top-of-file level comments, such as a description of the whole file/module/namespace ;;; Documentation for major code sections (i.e. groups of functions) within the file. ;; Documentation … Read more
For the case of Python, source files are compiled before being executed (the .pyc files), and the comments are stripped in the process. So comments could slow down the compilation time if you have gazillions of them, but they won’t impact the execution time.
From HTML comments: Since HTML is officially an SGML application, the comment syntax used in HTML documents is actually the SGML comment syntax. Unfortunately this syntax is a bit unclear at first. The definition of an SGML comment is basically as follows: A comment declaration starts with <!, followed by zero or more comments, followed … Read more
In Liquid you comment out using the {% comment %} and {% endcomment %} tags: {% comment %} This is a comment in Liquid {% endcomment %} It doesn’t matter if the comment is inline or a block comment. {% comment %} This is a block comment in Liquid {% endcomment %}
No, there are no inline comments in Python. From the documentation: A comment starts with a hash character (#) that is not part of a string literal, and ends at the end of the physical line. A comment signifies the end of the logical line unless the implicit line joining rules are invoked. Comments are … Read more
The priority of the task depends on the keyword you use to tag it. You can see and edit a list of keywords and their priorities by going to Tools->Options->Environment->Task List. For example, on my installation, I’ve got HACK, TODO and UNDONE as normal priority, and UnresolvedMergeConflict as high priority. If you want to add … Read more