optimize: use multiline comments for PHP files

[clemlatz]

What type of PR is this?

optimize: A new optimization

Check the PR title.

• This PR title match the format: <type>(optional scope): <description>
• The description of this PR title is user-oriented and clear enough for others to understand.

(Optional) More detail description for this PR.

I'd like to propose to use multiline comments for license headers in PHP files

/*
 * …
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, version 3.
 * …
 */

instead of single line comments

// …
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, version 3.
// …

This a more common practice as can be seen in Symfony, one of the mostly used PHP frameworks:
https://github.com/symfony/http-foundation/blob/3d7bbf071b25f802f7d55524d408bed414ea71e2/Response.php#L1-12

[justlorain]

Thank you again for your contribution!

By the way, NWA supports the --rawtmpl (-r) option, where you can specify a file path for a template.
NWA will read the content from this template file and add (or check, update, delete) it directly to the header of the file where a license header is needed. This option is suitable for users who have more advanced requirements for the license header.

For example, suppose you have created a nwatmpl.txt file in the current directory, then you can use this custom template with the following command:

nwa add -r nwatmpl.txt *.php

The content of nwatmpl.txt might look like this:

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
 

You may notice that both the first and last lines of nwatmpl.txt are blank. This is how you can achieve a format similar to Symfony's.

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

...

If you use NWA's built-in template to add the license header, NWA’s default behavior is to place the license header directly after <?php, resulting in something like this:

<?php
/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

...

So comparatively, --rawtmpl offers more flexibility. I will add documentation on this later.