The description of each parameter starts with its name followed by a parameter delimiter character (by default one of ":-") followed by at least one white space and finally followed by the description itself, as in the following example.
// Parameters:
// x - The X Coordinate of the item requested.
// y - The Y Coordinate of the item requested.
// z - The Z Coordinate of the item requested.
// CanCreate - if there is no Item located at the
// given position a new Item is created if
// CanCreate is true.
// Returns:
// An Item pointer or NULL if there is no item
// at the given position.
// Description:
// [...]
(C++)
Item *World::GetItem(int x, int y, int z, bool CanCreate)
{
[...]
}
(Pascal)
function World.GetItem(x: Integer; y: Integer; z: Integer; CanCreate: BOOLEAN): Item;
begin
[...]
end;
(C#)
<B>public class</B> World {
Item GetItem(<B>int</B> x, <B>int</B> y, <B>int</B> z,
<B>bool</B> CanCreate)
{
// do something here
}
}
(Java)
<B>public class</B> World {
Item GetItem(<B>int</B> x, <B>int</B> y, <B>int</B> z,
<B>bool</B> CanCreate)
{
// do something here
}
}
(VB.NET)
<B>class</B> World
<B>public function</B> GetItem(x <B>As Integer</B>, y <B>As Integer</B>, z <B>As Integer</B>,
CanCreate <B>As Boolean</B>) As Item
' do something here
<B>end function</B>
<B>end class</B>
