method commenting

Hi,i got a method

Code:

---

void searchStaff(string staffID){
}

---

I want to write a comment on top to describe the method.

i did this:

Code:

---

/*searchStaff(string staffID) function searches a staff.
@staffID is id of staff to be found*/

void searchStaff(string staffID){
}

---

is this correct way to specific wat the method parameter is for?

I suppose your double-post is a mistake. Maybe make the comment cleaner and separate explanation, arguments and the function name. Such as:

Code:

---

/* void searchStaff(std::string staffID): Search staff with ID staffID
  Parameters:
      - staffID: The ID of the staff to be found

... long explanation here */

---

Actually, everything is a matter of personal preference. That was just an example.

PS: Are you working with global variables? Because search functions normally do return a value.

Code:

---

/****************************************************************************
 *
 * NAME:  Enable_Device(arguments)
 *
 * DESCRIPTION:
 *          Data message processor callback.  This function processes
 *          any incoming data - probably from other devices.  So, based
 *          on cluster ID, perform the intended action.
 *
 *  Param: pkt - incoming message
 *
 *
 * RETURNS:
 *        none
 *
 ****************************************************************************/

---

*Moved to C++ programming forum*

Quote:

---

Originally Posted by rahulsk1947

I want to write a comment on top to describe the method.

---

One approach is to document the pre-conditions and post-conditions of the function.

Quote:

---

Originally Posted by rahulsk1947

is this correct way to specific wat the method parameter is for?

---

If you are using a documentation generation tool that recognises @staffID then yes, that is probably what you can do. On the other hand, the name is reasonably descriptive, so restating the parameter name in a comment does not really add information.

Aside from Brafil's observation, I note that you most likely should be passing the std::string by const reference.

Consider making whatever style you go for compatible with say Doxygen