Use a single # sign

    # like this
One character seems pretty minimal ;)

Also:  

    ###
    This block comment (useful for &#169;-Copyright info) also gets 
    passed on to the browsers HTML /* like this! */
    ###

The main way to comment is sh/Perl/Ruby/... style `#` comments:

    # This comment goes to the end of the line
    # and it won&#39;t appear in the &quot;compiled&quot;
    # JavaScript version.

You use the [block style `###` comments][1] when you want a comment to appear in the JavaScript version:

&gt; Sometimes you&#39;d like to pass a block comment through to the generated JavaScript. For example, when you need to embed a licensing header at the top of a file. Block comments, which mirror the syntax for heredocs, are preserved in the generated code.

So if you start with

    ###
    PancakeParser is Public Domain
    ###

then you&#39;d get this JavaScript comment in the generated JavaScript:

    /*
    PancakeParser is Public Domain
    */


  [1]: http://jashkenas.github.com/coffee-script/#strings


Beware of ###! If you use ### to separate sections of code (as I do) it&#39;s awfully surprising when that code stops working as a result.

How can I pass a `Block` to a `Function`/`Method`?

I tried `- (void)someFunc:(__Block)someBlock` with no avail.

ie. What is the *type* for a `Block`?

Objective-C pass block as parameter

I&#39;m trying to build a one-file EXE with PyInstaller which is to include an image and an icon. I cannot for the life of me get it to work with `--onefile`.

If I do `--onedir` it works all works very well.
When I use `--onefile`, it can&#39;t find the referenced additional files (when running the compiled EXE). It finds the DLLs and everything else fine, just not the two images.

I&#39;ve looked in the temp-dir generated when running the EXE (`\Temp\_MEI95642\` for example) and the files are indeed in there. When I drop the EXE in that temp-directory it finds them. Very perplexing.

This is what I&#39;ve added to the `.spec` file

    a.datas += [(&#39;images/icon.ico&#39;, &#39;D:\\[workspace]\\App\\src\\images\\icon.ico&#39;,  &#39;DATA&#39;),
    (&#39;images/loaderani.gif&#39;,&#39;D:\\[workspace]\\App\\src\\images\\loaderani.gif&#39;,&#39;DATA&#39;)]     

I should add that I have tried not putting them in subfolders as well, didn&#39;t make a difference.

**Edit:** *Marked newer answer as correct due to PyInstaller update.*


Bundling data files with PyInstaller (--onefile)

In what ways can you comment in CoffeeScript?

The documentation say you can use three hash symbols to start and close a comment block:

    ###
      Comments
      go
      here
    ###

I&#39;ve found that I can sometimes use the following two formats

    `// backticks allow for straight-JavaScript,
     // but the closing backtick can&#39;t be on a comment line (I think?)
    `

Are there a simpler way to insert short comments in CoffeeScript?

Do NOT use this style**

Since this is getting a lot of views, I want to emphasize that

    /* Comment goes here */

produces a MATH error when the `/*` is on its own line.

As Trevor pointed out in a comment on the question, this is a **regular expression**, **NOT** a comment!


How do I comment in CoffeeScript? &quot;/* this */&quot; doesn&#39;t work

In what ways can you comment in CoffeeScript?
The documentation say you can use three hash symbols to start and close a comment block:
<pre><code class="hljs language-shell">###
 Comments
 go
 here
###
</code></pre>
I've found that I can sometimes use the following two formats
<pre><code class="hljs language-arduino">`// backticks allow for straight-JavaScript,
 // but the closing backtick can't be on a comment line (I think?)
`
</code></pre>
Are there a simpler way to insert short comments in CoffeeScript?
Do NOT use this style**
Since this is getting a lot of views, I want to emphasize that
<pre><code class="hljs language-arduino">/* Comment goes here */
</code></pre>
produces a MATH error when the <code>/*</code> is on its own line.
As Trevor pointed out in a comment on the question, this is a regular expression, NOT a comment!

I have a Rails controller in which I am setting a instance variable -

    @user_name = &quot;Some Username&quot;

In my .slim template I am using coffee engine to generate javascript and want to print out the user name from client-sie javascript code -


    coffee:
      $(document).ready -&gt;
        name = &quot;#{@user_name}&quot;
        alert name


But this is the javascript that is being generated??

    $(document).ready(function() {
        var name;
        name = &quot;&quot; + this.my_name;
        alert(name);
    }

**How do I access controller instance variables in my CoffeeScript code??**

I am tagging this as haml since I am guessing haml will have the same issue when using CoffeeScript .



How to access instance variables in CoffeeScript engine inside a Slim template

I&#39;ve got this code that checks for the empty or null string. It&#39;s working in testing. 

    eitherStringEmpty= (email, password) -&gt;
      emailEmpty = not email? or email is &#39;&#39;
      passwordEmpty = not password? or password is &#39;&#39;
      eitherEmpty = emailEmpty || passwordEmpty         
    
    test1 = eitherStringEmpty &quot;A&quot;, &quot;B&quot; # expect false
    test2 = eitherStringEmpty &quot;&quot;, &quot;b&quot; # expect true
    test3 = eitherStringEmpty &quot;&quot;, &quot;&quot; # expect true
    alert &quot;test1: #{test1} test2: #{test2} test3: #{test3}&quot;

What I&#39;m wondering is if there&#39;s a better way than `not email? or email is &#39;&#39;`. Can I do the equivalent of C# `string.IsNullOrEmpty(arg)` in CoffeeScript with a single call? I could always define a function for it (like I did) but I&#39;m wondering if there&#39;s something in the language that I&#39;m missing. 


Easiest way to check if string is null or empty

I really like this:

    var value = maxValue &gt; minValue ? minValue : maxValue;

Is there something equally concise in Coffescript?

Conditional operator in Coffeescript

In CoffeeScript, what is the simplest way to check if a key exists in an object?

Simplest way to check if key exists in object using CoffeeScript

When building a class in CoffeeScript, should all the instance method be defined using the `=&gt;` (&quot;fat arrow&quot;) operator and all the static methods being defined using the `-&gt;` operator?

CoffeeScript, When to use fat arrow (=&gt;) over arrow (-&gt;) and vice versa

I have a set of variables I allow some people I work with to edit. These are True (`T`) and False (`F`) values, but I have some people that insist on putting `t` and `f` instead of the upper case values respectively. 

I use the following workaround code to properly set uppercase values:

    IF &#39;%dotnet35%&#39;==&#39;f&#39; set dotnet35=F
    IF &#39;%dotnet35%&#39;==&#39;t&#39; set dotnet35=T
    IF &#39;%dotnet40%&#39;==&#39;f&#39; set dotnet40=F
    IF &#39;%dotnet40%&#39;==&#39;t&#39; set dotnet40=T
    IF &#39;%regedit%&#39;==&#39;f&#39; set regedit=F
    IF &#39;%regedit%&#39;==&#39;t&#39; set regedit=T
    IF &#39;%SSL%&#39;==&#39;f&#39; set SSL=F
    IF &#39;%SSL%&#39;==&#39;t&#39; set SSL=T

This is however extremely bulky and it&#39;s not easy on the eyes... is there any other way of doing this without using VBS or any other programming language?

Windows batch command to ignore case sensitivity in variables

When doing a code review for a colleague today I saw a peculiar thing. He had surrounded his new code with curly braces like this:

    Constructor::Constructor()
    {
       existing code
 
       {
          New code: do some new fancy stuff here
       }

       existing code
    }

What is the outcome, if any, from this? What could be the reason for doing this? Where does this habit come from?

**Edit:**

Based on the input and some questions below I feel that I have to add some to the question, even though that I already marked an answer.

The environment is embedded devices. There is a lot of legacy C code wrapped in C++ clothing. There are a lot of C turned C++ developers.

There are no critical sections in this part of the code. I have only seen it in this part of the code. There are no major memory allocations done, just some flags that are set, and some bit twiddling.

The code that is surrounded by curly braces is something like:

    {
       bool isInit;
       (void)isStillInInitMode(&amp;isInit);
       if (isInit) {
         return isInit;
       }
    }

(Don&#39;t mind the code, just stick to the curly braces... ;) )
After the curly braces there are some more bit twiddling, state checking, and basic signaling.    

I talked to the guy and his motivation was to limit the scope of variables, naming clashes, and some other that I couldn&#39;t really pick up.

From my POV this seems rather strange and I don&#39;t think that the curly braces should be in our code. I saw some good examples in all the answers on why one could surround code with curly braces, but shouldn&#39;t you separate the code into methods instead?


Unnecessary curly braces in C++?

[The HTML5 documentation recommends][1] putting the `code` element inside the `pre` element, but I don&#39;t understand how this is better or more semantic than just using the code element and CSS. In their own example:

    &lt;pre&gt;&lt;code class=&quot;language-pascal&quot;&gt;var i: Integer;
    begin
       i := 1;
    end.&lt;/code&gt;&lt;/pre&gt;

Could also be written (Making some assumptions about the browser&#39;s defaults for `pre`):

    &lt;style&gt;
    code {
        display: block;
        white-space: pre;
    }
    &lt;/style&gt;
    …
    &lt;code class=&quot;language-pascal&quot;&gt;var i: Integer;
    begin
       i := 1;
    end.&lt;/code&gt;

  [1]: http://www.w3.org/TR/2011/WD-html5-author-20110809/the-code-element.html

Even if the `pre` is there to distinguish a code *block* from an inline string of code, I don&#39;t see it being a more semantic choice than specifying the *block-ness* of the `code` in a class.

Is there a specific reason the `pre` is recommended over a CSS solution?

Why does HTML5 recommend putting the code element inside pre?

How to auto-format code in Eclipse?

I have started developing with [Android Studio][1]. In Eclipse I was using &lt;kbd&gt;Ctrl&lt;/kbd&gt; + &lt;kbd&gt;Shift&lt;/kbd&gt; + &lt;kbd&gt;F&lt;/kbd&gt;, but in Android Studio it does not work. It will be different.

How can I jump to any method in a `.java` file? I was using &lt;kbd&gt;Ctrl&lt;/kbd&gt; + &lt;kbd&gt;O&lt;/kbd&gt; in Eclipse.

Is it available? What is the shortcut for code formatting?

  [1]: http://developer.android.com/sdk/installing/studio.html


Code formatting shortcuts in Android Studio for Operation Systems

I used this syntax as I found online but it throws an error:

    xmlns:x=&quot;http://schemas.microsoft.com/winfx/2006/xaml&quot;
    &lt;!-- Cool comment --&gt;
    xmlns:System=&quot;clr-namespace:System;assembly=mscorlib&quot;

&gt; &#39;Name cannot begin with the &#39;&lt;&#39; character, hexadecimal value 0x3C.
&gt; Line 4, position 5.&#39; XML is not valid.



How to add comments into a Xaml file in WPF?

I have written huge MS DOS Batch file. To test this batch file I need to execute some lines only and want to hide/comment out remaining. 

I have some existing comment lines starting with `::` hence I cannot use `::` anymore as it will scramble all comments.

How can I solve this problem?


Commenting multiple lines in DOS batch file

Can you write comments in a `.gitignore` file?

If so, should the line be preceded with a `#` or some other indicator?

Comments in .gitignore?

I have never, ever, seen a PHP file using hashes (`#`) for commenting. But today I realized that I actually can! I&#39;m assuming there&#39;s a reason why everybody uses `//` instead though, so here I am.

**Is there any reason, aside from personal preference, to use `//` rather than `#` for comments?**


Can I use a hash sign (#) for commenting in PHP?

I want to add comment in SQL code. How can I do this? I&#39;m using MySQL.

Content Type	Original Author	Original Content on Stackoverflow
Question	Eric Hu	View Question on Stackoverflow
Solution 1 - Coffeescript	Michael Durrant	View Answer on Stackoverflow
Solution 2 - Coffeescript	mu is too short	View Answer on Stackoverflow
Solution 3 - Coffeescript	Mark Wilden	View Answer on Stackoverflow

How do I comment in CoffeeScript? "/* this */" doesn't work

Coffeescript Problem Overview

Coffeescript Solutions

Solution 1 - Coffeescript

Solution 2 - Coffeescript

Solution 3 - Coffeescript

Bundling data files with PyInstaller (--onefile)

Objective-C pass block as parameter

Attributions