header_comment¶Add, replace or remove header comment.
comment_type¶Comment syntax type.
Note
The previous name of this option was commentType but it is now deprecated and will be removed on next major version.
Allowed values: 'comment', 'PHPDoc'
Default value: 'comment'
location¶The location of the inserted header.
Allowed values: 'after_declare_strict', 'after_open'
Default value: 'after_declare_strict'
separate¶Whether the header should be separated from the file content with a new line.
Allowed values: 'both', 'bottom', 'none', 'top'
Default value: 'both'
With configuration: ['header' => 'Made with love.'].
--- Original
+++ New
@@ -1,6 +1,10 @@
<?php
declare(strict_types=1);
+/*
+ * Made with love.
+ */
+
namespace A\B;
echo 1;
With configuration: ['header' => 'Made with love.', 'comment_type' => 'PHPDoc', 'location' => 'after_open', 'separate' => 'bottom'].
--- Original
+++ New
@@ -1,6 +1,10 @@
<?php
+/**
+ * Made with love.
+ */
+
declare(strict_types=1);
namespace A\B;
echo 1;
With configuration: ['header' => 'Made with love.', 'comment_type' => 'comment', 'location' => 'after_declare_strict'].
--- Original
+++ New
@@ -1,6 +1,10 @@
<?php
declare(strict_types=1);
+/*
+ * Made with love.
+ */
+
namespace A\B;
echo 1;
