User Tools

Site Tools


iotivity_c_code_review_notes

C/C++ Code Review

This is currently a quick summary of issues that might come up during a code review along with information, mitigations and remediations for them.

FAQ

  • Q: There was a @fn at the start of a comment. Why could this be an issue?
    /**
     * @fn PerformOperation
     * Performs an operation on the placeholder.
     *
     * @return A status value.
     */
    int PerformOperation();

    With the problem line being

     * @fn PerformOperation
    • A: Doxygen will normally look after the comment to automatically determine what is being discussed. Adding an explicit tag can get out of sync, cause duplicate information or other errors. See Efficient Doxygen Comments
  • Q:
    • A:

(add more as they are encountered)

iotivity_c_code_review_notes.txt · Last modified: 2015/02/12 10:27 by Jon A. Cruz