Commenting methods in c

Question

I wonder if its okay to comment methods in c in the same way you comment code in java-language?

/**
 * 
 * @param x
 * @param y
 * @return
 */
protected boolean myMethod(int x, int y) {



  return true;
}

that is in the same manner in c

 /**
 * 
 * @param x
 * @param y
 * @return
 */
int myMethod(int x, int y) {



  return 1;
}

Of course its up to the programmer but I would like to know if c-programmers uses these @param or not?

Answer 1

Of course its up to the programmer but I would like to know if c-programmers uses these @param or not?

In C, whatever you put inside the /**/ is treated as comments. But I dont think @param has got anything to do for it in C.

As far as @ is concerned the @ in Java is for the Javadoc functionality.

Answer 2

Doc-comments like these are not commonly used in C. They may be useful in some IDEs to generate documentation for functions, but I don't recall ever seeing these comments in C source code.