[5.8] Enh: FactoryMakeCommand updated to generate more IDE friendly code

[klimov-paul]

Update 'make:factory' command to generate code, which is more consistent regardless to other generators:

• import model via use statement instead of usage fully qualified class name inline.
• added PHPDoc hint for $factory variable, facilitating better IDE type-hinting and static analysis

With this patch command php artisan make:factory -m Foo FooFactory generates following code:

<?php

/* @var $factory \Illuminate\Database\Eloquent\Factory */

use Faker\Generator as Faker;
use App\Foo;

$factory->define(Foo::class, function (Faker $faker) {
    return [
        //
    ];
});

[ahinkle]

Please remove this DocBlock. #24647.

[ejunker]

Is this correct? I think DockBlocks have to start with /** and this is just /*

http://docs.phpdoc.org/guides/docblocks.html

[klimov-paul]

Such var description should be recognized correctly by any modern IDE. It is recognized by PHPStorm at least.
In the same time having this as PHPDoc block (e.g. `/**``) may cause problem with PHP code style fixers as they consider this to be a PHPDoc, which is not bound to function or class definition, and thus is incorrect.

[klimov-paul]

This has requested and denied many times.

If some changeset constantly reappear in PRs, perhaps it means there is a point behind it, and it should be reconsidered from different angle.

Without the doc comment IDE consider factory code as the one containing an error and does not provide type-hinting in case you with to add a state definition:

With the doc comment IDE consider code to be corrent and provide the type-hint for the factory methods:

Please remove this DocBlock

Sorry, would not do this. You are free to edit the PR manually or close it altogether, I see not point to spent any more efforts in this.

[taylorotwell]

I'll just give in on this, heh. I think it kinda harms the "tranquility" of the file having some IDE centric docblock in there but I'm just tired of fighting that battle and maybe I'm wrong anyways. 🤷‍♂️

[ahmadmayahi]

Too late to comment on this, but I disagree with such additions.
This is a trick rather than an improvement.