comments

Including comments in Java regular expressions

I have some complex regular expressions which I need to comment for readability and maintenance. The Java spec is rather terse and I struggled for a long time getting this working. I finally caught my bug and will post it as an answer but I'd be grateful for any other advice on maintaining regexes As an example I want to comment the sub...

How can we catch side comments using Perl::Tidy or Perl::Critic?

My department is currently settling on some general code best practices, which we would like to somewhat enforce, providing developers with Perl::Tidy and Perl::Critic configurations. Now we are having problems with side comments. The side comment is this: my $counter = 0; # Reset counter We would prefer to not have side comments at...

Doxygen style comments in Kate

Kate features a very handy shortcut (Ctrl+D) to apply single- and multi-line comment to the selected region of text. How can I configure Kate to apply doxygen style comments in C/C++ source files? /** * reduces the channel complexity * args: None * returns: None */ void Channel::reduce(); ...

## in python using notepad++ syntax coloring

In my editor (notepad++) in Python script edit mode, a line ## is this a special comment or what? Turns a different color (yellow) than a normal #comment. What's special about a ##comment vs a #comment? ...

Are there any programs to aid in the mass-editing of Visual SourceSafe checkin comments?

I know that in Visual SourceSafe you can go in and drill down to the history of an individual file and then drill down to an individual check-in and apply a comment to the check-in that way but that's tedious and time consuming - if you have a lot of files that were checked in at the same time and you want the same comment to apply to al...

Is it possible to use inline comments for .ini files with PHP?

Is it possible and safe to use inline comments for .ini files with PHP? I prefer a system where the comments are inline with the variables, coming after them. Are the some gotchas concerning the syntax to be used? ...

Regex to match tags in comments.

I want to get a regex which will match a tag in a java comment so I can replace it with a .net comment. eg I have this: /** * Some method description * * @param paramName Parameter description * which may span more than 1 line * @return return value. * @throws ExceptionName some exception description * again may span...

Commenting out a set of lines in a shell script

I was wondering if there is a way to comment out a set of lines in a shell script. How could I do that? We can use /* */ in other programming languages. This is most useful when I am converting/using/modifying another script and I want to keep the original lines instead of deleting. It seems a cumbersome job to find and prefix # for al...

Commenting in BASH script

How can I comment on each line of the following lines from a script: cat ${MYSQLDUMP} | \ sed '1d' | \ tr ",;" "\n" | \ sed -e 's/[asbi]:[0-9]*[:]*//g' -e '/^[{}]/d' -e 's/""//g' -e '/^"{/d' | \ sed -n -e '/^"/p' -e '/^print_value$/,/^option_id$/p' | \ sed -e '/^option_id/d' -e '/^print_value/d' -e 's/^"\(.*\)"$/\1/' |...

ASP.NET Server-Side Comments inside <script> Block

Hello, I know that you can create 'server-side comments' (they won't be sent as comments/text to the client) in ASP.NET (MVC) via the <%-- Comment --%> tags. However, I can't seem to do this inside of a <script> tag -- if I try this I get a bunch of code underlined in red, and weird unrelated errors ("Invalid expression term '}') etc. ...

Space between line-comment character(s) and start of actual comment

I realize that this rule might differ from one company's coding standards to another, but in general, which is preferred? With a space after the line-comment: int foo = Bar(quux + 1); // compensate for quux being off by 1 foo = Bar(quux + 1) # compensate for quux being off by 1 2. No space after the line comment: int foo = B...

Any way to embed a comment within a Tcl command?

I would like to have a comment within a command and it appears that this is not possible given that the '#' character is defined in Tcl 8.4 to be: If a hash character (``#'') appears at a point where Tcl is expecting the first character of the first word of a command, then the hash character and the characters that follow it, up through...

Are there any website comments systems available (like phpbb for forums)?

I'm looking to add comments to my website. I've seen some great frameworks for forums (like phpbb) and for blogs (like wordpress). Is there anything like this for comment systems? ...

How to IE8 conditional comment.....

Very Simple Question but I am finding it hard to get a good answer If I wanted to remove certain divs when IE8 is used to view my webpage how would I do this ? could you give me a coded example please. Thanks ...

Way to include text in beamer presentations that is shown at handouts but not at the slides

Hi, is there some nice way in Beamer presentations (Latex) to include text (own remarks) that wouldn't be shown at the slides but would be printed with the handouts (little bit like the comments with Powerpoint? br, Touko ...

Is there a way to parse out HTML Comments on the Server side (PHP or MySQL)

We need a way to remove HTML comments when displayed to the user but not to the developer. I'm wondering what the best way to do this is. ...

What to use when text comments just wont do?

Hi - I'm writing a graphics application that's maths and geometry intensive. Frequently, I find that although I comment my code as best as I can, after sometime of working on some other part of the app, the previous comments become are hard to understand when I revisit it (usually for debugging). I'm starting to think that there are cas...

Commenting in Visual Studio 2008

I'm trying to comment/uncomment a block of code using the shortcut "Ctrl+C" and "Ctrl+K", but it's not working. Nothing happens. Anyone know why? ...

Customize XML comments in Visual Studio 2008

In VS2008 just before a method if you add “///” it automatically adds the summary block… Do you know if it is possible to modify the default to this? /// <summary> /// Author : Failboy /// </summary> I would like it to have my in by default – without having to add it every time ...

how to set default name & company name on comments in Xcode?

When we add a new file, In .h & .m file, there is always a comments/documentation section at top. example. // // SimpleGameAppDelegate.m // SimpleGame // // Created by hbmac2 on 01/10/09. // Copyright __MyCompanyName__ 2009. All rights reserved. // Here, there is by default hbmac2 - is user name & MyComapnyName is also default. ...