Replace C style comments by C++ style comments

问题:

How can I automatically replace all C style comments (/* comment */) by C++ style comments (// comment)?

This has to be done automatically in several files. Any solution is okay, as long as it works.

回答1:

This tool does the job: http://people.sc.fsu.edu/~burkardt/cpp_src/recomment/recomment.html

RECOMMENT is a C++ program which converts C style comments to C++ style comments.

It also handles all the non-trivial cases mentioned by other people:

This code incorporates suggestions and coding provided on 28 April 2005 by Steven Martin of JDS Uniphase, Melbourne Florida. These suggestions allow the program to ignore the internal contents of strings, (which might otherwise seem to begin or end comments), to handle lines of code with trailing comments, and to handle comments with trailing bits of code.

回答2:

This is not a trivial problem.

int * /* foo 
  /* this is not the beginning of a comment.

int * */ var = NULL;

What do you want to replace that with? Any real substitution requires sometimes splitting lines.

int * // foo
  // this is not the beginning of a comment.
// int *
var = NULL;

回答3:

How do you intend to handle situations like this:

void CreateExportableDataTable(/*[out, retval]*/ IDispatch **ppVal)
{
 //blah
}

Note the comment inside the parens... this is a common way of documenting things in generated code, or mentioning default parameter values in the implementation of a class, etc. I'm usually not a fan of such uses of comments, but they are common and need to be considered. I don't think you can convert them to C++ style comments without doing some heavy thinking.

回答4:

I'm with the people who commented in your question. Why do it? Just leave it.

it wastes time, adds useless commits to version control, risk of screwing up

EDIT: Adding details from the comments from the OP

The fundamental reason of preferring C++-style comment is that you can comment out a block of code which may have comments in it. If that comment is in C-style, this block-comment-out of code is not straight forward. – unknown (yahoo)

that might be a fair/ok thing to want to do, but I have two comments about that:

• I know of no one who would advocate changing all existing code - that is a preference for new code. (IMO)
• If you feel the need to "comment out code" (another iffy practice) then you can do it as needed - not before

It also appears that you want to use the c-style comments to block out a section of code? Or are you going to use the // to block out many lines?

One alternative is a preprocessor #ifdef for that situation. I cringe at that but it is just as bad as commenting out lines/blocks. Neither should be left in the production code.

回答5:

Here's a Python script that will (mostly) do the job. It handles most edge cases, but it does not handle comment characters inside of strings, although that should be easy to fix.

#!/usr/bin/python

import sys

out = ''
in_comment = False

file = open(sys.argv[1], 'r+')
for line in file:
    if in_comment:
        end = line.find('*/')
        if end != -1:
            out += '//' + line[:end] + '\n'
            out += ' ' * (end + 2) + line[end+2:]
            in_comment = False
        else:
            out += '//' + line
    else:
        start = line.find('/*')
        cpp_start = line.find('//')
        if start != -1 and (cpp_start == -1 or cpp_start > start):
            out += line[:start] + '//' + line[start+2:]
            in_comment = True
        else:
            out += line

file.seek(0)
file.write(out)

回答6:

I recently converted all C-style comments to C++-style for all files in our repository. Since I could not find a tool that would do it automatically, I wrote my own: c-comments-to-cpp

It is not fool-proof, but way better than anything else I've tried (including RECOMMENT). Among other things, it supports converting Doxygen style comments, for instance:

/**
* @brief My foo struct.
*/
struct foo {
  int bar;  /*!< This is a member.
                 It also has a meaning. */
};

Gets converted to:

/// @brief My foo struct.
struct foo {
  int bar;  ///< This is a member.
            ///< It also has a meaning.
};

回答7:

Why don't you write a C app to parse it's own source files? You could find the /* comments */ sections with a relatively easy Regex query. You could then replace the new line characters with new line character + "//".

Anyway, just a thought. Good luck with that.

回答8:

If you write an application/script to process the C source files, here are some things to be careful of:

• comment characters within strings
• comment characters in the middle of a line (you might not want to split the code line)

You might be better off trying to find an application that understands how to actually parse the code as code.

回答9:

There are a few suggestions that you might like to try out:

a)Write your own code (C/ Python/ any language you like) to replace the comments. Something along the lines of what regex said or this naive solution 'might' work: [Barring cases like the one rmeador, Darron posted]

 
for line in file:
    if line[0] == "\*":
       buf = '//' + all charachters in the line except '\*'
       flag = True
    if flag = True:
       if line ends with '*/':
          strip off '*/'
          flag = False
       add '//' + line to buf

b)Find a tool to do it. (I'll look up some and post, if I find them.)

c)Almost all modern IDE's (if you are using one) or text editors have an auto comment feature. You can then manually open up each file, select comment lines, decide how to handle the situation and comment C++ style using an accelerator (say Ctrl + M). Then, you can simply 'Find and Replace' all "/*" and "*/", again using your judgment. I have Gedit configured to do this using the "Code Comment' plugin. I don't remember the way I did it in Vim off hand. I am sure this one can be found easily.

回答10:

If there are just "several files" is it really necessary to write a program? Opening it up in a text editor might do the trick quicker in practice, unless there's a whole load of comments. emacs has a comment-region command that (unsurprisingly) comments a region, so it'd just be a case of ditching the offending '/*' and '*/'.

回答11:

Very old question, I know, but I just achieved this using "pure emacs". In short, the solution looks as follows:

Run M-x query-replace-regexp. When prompted, enter

/\*\(\(.\|^J\)*?\)*\*/

as the regex to search for. The ^J is a newline, which you can enter by pressing ^Q (Ctrl+Q in most keyboards), and then pressing the enter key. Then enter

//\,(replace-regexp-in-string "[\n]\\([ ]*?\\)   \\([^ ]\\)" "\n\\1// \\2" \1))

as the replacement expression.

Essentially, the idea is that you use two nested regex searches. The main one simply finds C-style comments (the *? eager repetition comes very handy for this). Then, an elisp expression is used to perform a second replacement inside the comment text only. In this case, I'm looking for newlines followed by space, and replacing the last three space characters by //, which is nice for preserving the comment formatting (works only as long as all comments are indented, though).

Changes to the secondary regex will make this approach work in other cases, for example

//\,(replace-regexp-in-string "[\n]" " " \1))

will just put the whole contents of the original comment into a single C++-style comment.

回答12:

from PHP team convention... some reasonning has to exist if the question was asked. Just answer if you know.

Never use C++ style comments (i.e. // comment). Always use C-style comments instead. PHP is written in C, and is aimed at compiling under any ANSI-C compliant compiler. Even though many compilers accept C++-style comments in C code, you have to ensure that your code would compile with other compilers as well. The only exception to this rule is code that is Win32-specific, because the Win32 port is MS-Visual C++ specific, and this compiler is known to accept C++-style comments in C code.