prototyping c functions

alaios · 05-01-2012, 06:12 AM

Dear all,
I would like to ask you about prototypinc c functions.

In R for example, we have prototyped the way we write functions, how we add comments, how we define function names e.t.c

Then a Roxygen system parse that files and creates the dependencies between all the source files.

Do you have some good articles or few suggestions of how do the function prototyping (where to write commetns for a function, add author details) for c language?

I would like to thank you in advance for your help

B.R
Alex

knobby67 · 05-01-2012, 06:51 AM

I'm unfamiliar with the term prototyping for c? So am guessing you mean ( for me ) either testing or by your post style? For style there's a whole load of styles K&R and dozens of others. He's the first example from google http://google-styleguide.googlecode....k/cppguide.xml, http://en.wikipedia.org/wiki/Programming_style, http://en.wikipedia.org/wiki/Indent_style#K.26R_style, http://www.jetcafe.org/jim/c-style.html, http://en.wikibooks.org/wiki/C++_Pro...tions/Comments.

crabboy · 05-01-2012, 08:45 AM

A function prototype is the function signature, return types and args, without the method body. This is generally found in the header files. Most companies / projects have standard ways of doing this. A quick google search on 'C function header comments' produced a lot of examples, that is a good place to start.

alaios · 05-01-2012, 09:59 AM

I also mean how do you write comment about what a function returns, how to use it, give a small example.. and the present that to the programmer as part of "api"

Nylex · 05-01-2012, 12:11 PM

You use Roxygen for R, so why not Doxygen for C?

alaios · 05-01-2012, 03:18 PM

I will check it and send more thoughts tomorrow.

Take Rest
Alex