我们在上一篇《剑鱼论坛插件的位置以及插件文件的生成》一文里面介绍了剑鱼论坛插件位置以及创建插件文件需要注意的几点事项。这一篇我们将进一步来学习插件制作,在正式写代码之前,我们需要写插件的注释,注释对于剑鱼插件来说十分重要。我们制作插件之前首先要在插件文件的最开头写注释,并且注释需要按要求写。下面我们来详细说明。
我们还是接着上一篇的内容继续,在上一篇我们已经建了一个插件文件“Myplugin.php”。剑鱼论坛是使用PHP语言编写的,所以您写的插件文件也必须是一个PHP文件。我们在这个插件文件里面会写下一些计算机能够识别的代码,当然我们在一般的PHP文件里面所写的注释会被计算机所忽略,但是在剑鱼论坛的插件文件里面注释是跟正式代码一样重要的内容。
我们在PHP文件里面首先写下:
<?php
这个是每个PHP文件开头都需要的,然后我们换行写注释:
<?php
/**
* 插件名: 我的插件
* 描述: 这是一个用于演示的插件
* 作者: A.J
* 版本: 1.0
* 插件网址: http://jianyuluntan.com
*/
上面所写的就是对插件进行描述的注释文字,其中冒号“:”左边的必须按原样写,冒号右边的具体信息请根据您制作的插件实际情况写。这里作为一个演示案例,我把插件名设定为“我的插件”,描述是“这是一个用于演示的插件”,后面就是作者、插件版本等信息。
这篇介绍了剑鱼论坛制作的注释写法,我们在下一篇《剑鱼论坛插件代码基本结构》将正式学习插件代码如何写。