comments

Convert Single Line Comments To Block Comments

I need to convert single line comments (//...) to block comments (/*...*/). I have nearly accomplished this in the following code; however, I need the function to skip any single line comment is already in a block comment. Currently it matches any single line comment, even when the single line comment is in a block comment. That can't ha...

How to handle ridiculous comments?

Working in a classic VB6 app, crazy comments by the thousands. Example: If garrFilePaths(i).FilePath = "" Then 'do nothing Else MsgBox "File Not Found (" & garrFilePaths(i).FilePath & ")", vbOKOnly, gcstrMessageBoxTitle End If ...

wordpress add comment like stackoverflow

i have posted this link ages ago regarding wordpress: http://stackoverflow.com/questions/196993/wordpress-having-comments-inline-ajax-like-in-stackoverflow and i think that i maybe didn't describe my request properly as each of the given solutions dont actually do what i am looking for: I would like it when i click on "Add Comment" un...

Are there any conventions for writing POD comments for Perl?

I was able to find a page from Safari Books Online that provides a template, but having never written POD comments, I'm not sure how good it is or if it is missing anything that might be considered convention to include. What are the conventions to follow when writing POD comments for Perl scripts? Is there anything like Sun's Javadoc C...

Python: What is the common header format?

I came across the following header format for Python source files in a document about Python coding guidelines: #!/usr/bin/env python """Foobar.py: Description of what foobar does.""" __author__ = "Barack Obama" __copyright__ = "Copyright 2009, Planet Earth" Is this the standard format of headers in the Python world? What oth...

C# XML Comments: How many <see ... /> references in XML comments are useful ?

In our company we write excessive Xml comments. A typical method is has to be documented like this: /// <summary> /// Determines whether this <see cref="IScheduler"/> contains a specific <see cref="ISchedule"/>. /// </summary> /// <param name="schedule">The <see cref="ISchedule"/> to locate in this <see cref="IScheduler"/>.</pa...

Expression Engine Problem - Javascript error in comments

Hi, I am having a problem with the comments system on my site. The comments are displayed with a javascript error message. This is the error message I get when a user attempts to post a comment: .(JavaScript must be enabled to view this email address) posted on Fri Oct 09, 2009 at 04:19 PM Attached below is the snippet of code tha...

Visual Studio Magic Keywords in Comments

Hi, I know visual studio has some magic keywords you can use in comments, which will make them marked in the Task List: TODO HACK UNDONE Do you know of any other built-in keywords, that may mark the code as a task? Or any other special keywords that will mark the code as bug-fix, warning, error, etc. Thanks. ...

Need VB code commented to convert it to Java

I am a Java developer. I have the task of converting a VB class to Java. Can some VB developer comment the following VB code so that I can write its Java equivalent? Public Class RmaValidationCode ' Values for test type Public Const SOFTWARE_TEST_TYPE = 0 Public Const FIRMWARE_TEST_TYPE = 1 ' Values for test length ...

Rails Comments on View if-end statement screw up rendering on Linux/Apache/FastCGI

Hi, the following code does work under my Windows development environment, but not on my production Linux/Apache2/FastCGI env. in my view rhtml file : <td id='first_column' class='column'> <% content_for :head do #DO NOT CACHE THIS content for : HEAD %> <%= stylesheet_link_tag('live_tree') %> <%= javascr...

Stop Eclipse from mangling my comments

Is there a way to stop eclipse from mangling the comments in my source files? My main issue is stopping it from word wrapping them. I've managed to configure eclipse to not word wrap any code but it still seems to do it to comments. Code that I enter like this: public int myVariable = 100; // this variable is a very interesting variab...

[C++] Where are doxygen comments appropriate/necessary?

I don't have much experience with documentation tools like doxygen, so I'm not sure exactly how in-code documentation should look. Should I write doxygen-style comments for each member variable in a class? Or is this overkill if the variable names are fairly self-explanatory? Should I include the comments from a header in the correspon...

Is there any tool for commenting JavaScript code?

Hi All, Is there any tool for javascript commenting as it is in c# like ghost doc. /// <summary> /// Method to calculate distance between two points /// </summary> /// <param name="pointA">First point</param> /// <param name="pointB">Second point</param> function calculatePointDistance(pointA, pointB) { ... } there any tool...

vb.net - automatic XML comments - ''' -- Can I change the automatic defaults?

I'm using Visual Studio 2008 SP1 in VB.NET, when I type ''' above a function, some automatic default XML comments appear: ''' <summary> ''' ''' </summary> ''' <remarks></remarks> I would like this to be the following instead: ''' <summary></summary> ''' <remarks></remarks> Is there a way to change what appears when you type ''' a...

Comments within style= attributes - safe?

I am working on a CMS that generates CSS "style='xyz'" statements from user input. The user input will be validated but as an additional safeguard, I want to check the validity of the values on generation of the CSS code. If an invalid value is encountered - e.g. a relative width ("50%") where only absolute values are allowed due to lay...

Is there a way to include body comments in javadocs?

We've got a large codebase of Java (with a smattering of Groovy mixed in) that, by and large, has no javadocs written for it. However, much of the code is reasonably well documented in "old-school" comments scattered throughout the body. We're now on something of a push to try and get things documented a little better - Javadocs are no...

Can you give me examples of odd single line comments in C++?

I wrote a method to remove single line comments from a C++ source file: def stripRegularComments(text) { def builder = new StringBuilder() text.eachLine { def singleCommentPos = it.indexOf("//") def process = true if(singleCommentPos > -1) { def counter = 0 it.eachWithIndex { obj,i -> if((obj == '\'')...

Best rails plugin for comments?

What is the best plugin or gem for adding comments to the ActiveRecord models in rails? Maybe there is one with ability to rate each comments with votes +1/-1 (like on youtube for example) and a cool view helper to display comments in a tree? ...

Google Code: Force comment on commit

I just started using Google code hosting and am a beginner at working with Subversion. I was wondering if there is a way to enforce a rule that no commits can be made without comments. I was researching into it, and I did find a way to do this on subversion - it involves creating a pre-commit hook. But I don't think I can do this in Goog...

Request for comments: What should the syntax be to include code snippets in Markdown? (from external files)

I've been using Markdown recently. One of my biggest problems with Markdown is that Markdown has no syntax for including files within a document (vs., say, the listings package for LaTeX). I'd like to extend Markdown to support including whole and partial files as code snippets. For instance, it could look like this: ![:include src/fo...