Will php documentation conflict with wordpress documentation?

Question

Hi I have a php script that makes liberal use of

/* */

//

my question is will that conflict with wordpress since the wordpress engine often reads variables inside those things?

The reason I ask is that to make a custom template, you just modify some text inside the documentation in the first part of the script

/** * Template Name: Full Width Page * * @package WordPress * @subpackage Twenty_Fourteen * @since Twenty Fourteen 1.0 */

I worry my documentation inside my script could cause wordpress to do unexpected actions or worse create a security vulnerability

Answer 1

I believe the practice of including additional data within PHP code comments is typically called annotations.

WordPress core makes no use of annotations technique for any code runtime tasks and doesn't have an API for such purpose.

In number of context it will read file headers to extract meta data, such as main plugin files and some theme templates. As long as you follow documentation and include necessary elements for those I doubt you are going to have any trouble with them.