Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:105054
Date: Wed, 3 Apr 2019 18:56:24 +0200
To: "M. W. Moe" <mo.mu.wss@gmail.com>
Cc: PHP internals <internals@lists.php.net>
Message-ID: <etPan.5ca4e5bd.10c5b140.311@stijnpeeters.nl>
In-Reply-To: <CAHN63oOfR3DD9b_xHLPUh20=jJFQTJH+Qce298k-4vm6X4bdKg@mail.gmail.com>
References: <CAHN63oMjO-7cdnF55Mrj-MxVrq9mvm5=c2M681CuXLkE_Hez_A@mail.gmail.com>
 <CAESVnVpcTTC-77EjLgH-9jwbPgzaR2x_JV+D00SMffWKgU=bkw@mail.gmail.com>
 <CAHN63oP4p-VdK=J3L3vi0GygHawRq5KkCHJEF0tFoQBtSezGiQ@mail.gmail.com>
 <CALKiJKrbcv42cyWYqLfizzNVGc55Z4qEW+X6gfxzoVENSrnZuw@mail.gmail.com>
 <CAHN63oOfR3DD9b_xHLPUh20=jJFQTJH+Qce298k-4vm6X4bdKg@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/alternative; boundary="5ca4e5bd_30718a18_311"
Subject: Re: [PHP-DEV] Question about adding !function_identifier
From: ik@stijnpeeters.nl (Stijn Peeters)

--5ca4e5bd_30718a18_311
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

I think the issue here is that there is no functional difference between =
an exclamation mark prefix and a docblock attribute, and the latter has t=
he advantage of being more explicit, not requiring changes to the languag=
e syntax itself, and being an already-existing standard.=C2=A0

Of course things may move around during the development process, but I do=
n't really see how you can't move around the docblocks with the functions=
 they belong to... A decent IDE will make this easy and can also use the =
=40throws tag to provide the contextual information you're looking for, a=
gain, without having to change the language itself.

Best,
Stijn



Op 3 april 2019 bij 18:52:58, M. W. Moe (mo.mu.wss=40gmail.com) schreef:

Hello, =20

not documenting at first is not really a question of laziness or so, as =20
things are still moving around =20
you absolutely need this agility; a good design layout between theory and=
 =20
stable state will refactored =20
discussed a thousand times; that what I expect from engineers; filling th=
e =20
gaps between assumptions =20
and reality. =20

And for me-self throw vs no throw is important language information and =20
part of internal behaviors; =20
to clarify, for instance, would be more useful to have such indicator =20
rather than having having =20
abstract and interface which are cumbersome; same as the extra public =20
keyword; you can do without =20
especially with the new traits construct. =20

Best. =20


On Wed, Apr 3, 2019 at 9:42 AM Rowan Collins <rowan.collins=40gmail.com> =
=20
wrote: =20

> On Wed, 3 Apr 2019 at 17:27, M. W. Moe <mo.mu.wss=40gmail.com> wrote: =20
> =20
> > yes this is very true; but usually on complex design with a lot of fo=
lks =20
> > working on it you start coding before documenting; =20
> > =20
> =20
> =20
> If it's just syntax that doesn't change behaviour, it's really just =20
> documentation anyway, and if people are so desperate to dig into the co=
de =20
> that they can't write a minimal docblock (or so lazy that they won't), =
how =20
> likely is it that they'll correctly add this new indicator=3F =20
> =20
> If you want to be explicit, don't put off docblocks until later (writin=
g =20
> them before you've even implemented the function can be a great way of =
=20
> clarifying your design), and use an IDE or CI tool that will tell you w=
hen =20
> they're missing or incorrect. =20
> =20
> Regards, =20
> -- =20
> Rowan Collins =20
> =5BIMSoP=5D =20
> =20

--5ca4e5bd_30718a18_311--