This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: c-gimplify.c:gimplify_decl_stmt


    > The comments in front of the funciton reference variables inside the
    > function, which is wrong.

    I don't know that this is "wrong" as long as it's useful. Describing the
    algorithm or high level stuff that's needed to understand the function.

No, it's confusing.

Comments *before* the function are supposed to explain the *specification*
of the function, which means what a *caller* of the function needs to know.

Descriptions of variables *within* the function are indeed useful (if
up to date), but they belong inside the function body.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]