标签:php phpstorm phpdoc phpdocumentor2
我最近创建了一个用于创建HTML元素的类.我没有为每个现有的HTML元素和属性创建方法而烦恼,而是决定使用魔术方法__get和__call.所以使用我的代码我基本上可以这样做:
$signUpForm->insert->input->type('text')->name('firstName')->maxlength(100)->disabled
$signUpForm->insert->input->type('email')->name('emailAddress')->maxlength(100)
等等
但既然我决定保持这种“神奇”和简单,我也可以这样做:
$signUpForm-> insert-> magic-> trick(‘rabbit’) – > accessory(‘hat’)会导致:
<magic trick='rabbit' accessory='hat'>
这一切都很好,因为在我看来它削减了很多样板代码,并且正是我需要做的.我不希望一个类强制执行HTML标准,我想要一个类来促进HTML,因为你知道如何使用它(老实说,这样做的代码很小)
所以我的问题是,考虑到这个类可以接受任何未定义的属性或方法,有没有办法在PHPDoc中指定这种行为?我没有运气就尝试了以下内容:
/**
* @property HtmlElementAttribute * Insert a new HTML element attribute
* @method HtmlElementAttribute * Insert a new HTML element attribute
*/
我不知道这只是一个PHPStorm的东西,但我找不到任何类似的场景……
此外,如果您想知道为什么我会做这样的事情,那就是跟踪我的PHP代码中的某些HTML方面(例如,在表单中声明的ID或表单内的元素).这可以让我在发送给最终用户之前在我的HTML中具有可见性.
解决方法:
问题仍然在未答复的清单中萎缩,所以我将回答它.
为了在使用自动魔法方法(如__get()和__call())时在PhpStorm或Sublime中获得良好的代码智能,您需要为添加的每个隐式属性或方法包含@property或@method行.我知道这很糟糕,但这是使用这些方法的成本.
如果你真的得到了足够的回报,请考虑使用__get().它可能适合您的应用,在这种情况下它没关系.当我们尝试对对象数据进行进一步处理或抽象时(例如驼峰式名称转换),我们通常会使用它.你保存了一些代码(无论如何PhpStorm会为你写的),但是你需要在课堂上编写PhpDoc DocBlock行.
如果没有其他原因,请考虑包括所有行,而不是记录您的课程.使用隐式属性,您不仅难以让IDE知道哪些方法和属性是有效成员,而且还会让下一个维护者变得困难.那些docblock行似乎是多余的,但它们是很棒的文档.
标签:php,phpstorm,phpdoc,phpdocumentor2 来源: https://codeday.me/bug/20190609/1206603.html
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。