FUDforum: comp.lang.php » Using function prototypes in code

Home » Imported messages » comp.lang.php » Using function prototypes in code

Show: Today's Messages :: Polls :: Message Navigator

Re: Using function prototypes in code [message #175044 is a reply to message #175036]

Fri, 05 August 2011 12:52

Umberto Salsi
Messages: 2
Registered: August 2011

Karma:

Junior Member

webber <frank(dot)thynne(at)gmail(dot)com> wrote:

> In the interest of clarity and maintainability I would like to be able
> to write code that makes it clear what kind of arguments a function
> expects and what it returns.
>
> This is what I tried:
>
> function integer int_func(string $s) {
> // does something like, say, converting "five" to 5
> }
>

I suggest one of these

- phpDocumetor (www.phpdoc.org) generates docs from DocBlocks.

- Doxygen (www.doxygen.org) generates docs from DocBlocks.

- PHPLint (www.icosaedro/phplint) generates docs from DocBlocks, but
it is mainly a static source analyzer that implements it own parser for
the PHP language and checks if the declarations actually correspond to
the usage in the code performing a strict type check (numbers go with
numbers, strings with strings and so on). This latter is mine :-)

All these tools support a specially formatted comment named "DocBlock",
with which the function above becomes:

/**
* Short description here. Longer description follows in the
* next sentences.
* @param string $s Name of something, or similar.
* @return int Some value that tells something so and so.
*/
function int_func($s){...}

Regards,
___
/_|_\ Umberto Salsi
\/_\/ www.icosaedro.it

Report message to a moderator

[Message index]

		Using function prototypes in code By: webber on Fri, 05 August 2011 00:53
		Re: Using function prototypes in code By: Jerry Stuckle on Fri, 05 August 2011 03:08
		Re: Using function prototypes in code By: Jerry Stuckle on Fri, 05 August 2011 03:11
		Re: Using function prototypes in code By: alvaro.NOSPAMTHANX on Fri, 05 August 2011 06:35
		Re: Using function prototypes in code By: Umberto Salsi on Fri, 05 August 2011 12:52

Previous Topic:	From city to lati and long
Next Topic:	Regarding Session reset

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Wed Nov 27 00:31:06 GMT 2024

Total time taken to generate the page: 0.04535 seconds