Как добавить документацию для моих функций в Netbeans PHP?

Question

Я попробовал следующее,

/*
 * addRelationship
 *
 * Adds a relationship between two entities using the given relation type.
 *
 * @param fromKey the original entity
 * @param toKey the referring entity
 * @param relationTypeDesc the type of relationship
 */

function addRelationship($fromKey, $toKey, $relationTypeDesc) {
    $relationTypeKey = $this->getRelationTypeKey($relationTypeDesc);

Но, когда я попытался использовать его в другом месте, он говорит, что PHPDoc не найден.

Есть идеи о том, как заставить это работать в NetBeans PHP?

ОБНОВЛЕНИЕ:

Ниже приведен обновленный синтаксис, который будет работать в NetBeansPHP -

/** 
 * addRelationship
 *
 * Adds a relationship between two entities using the given relation type.
 *
 * @param integer $fromKey the original entity
 * @param integet $toKey the referring entity
 * @param string $relationTypeDesc the type of relationship
 */

function addRelationship($fromKey, $toKey, $relationTypeDesc) {

Answer 1

В первой строке отсутствует звездочка *: Попробуйте

/**
 * addRelationship
 *
 * Adds a relationship between two entities using the given relation type.
 *
 * @param fromKey the original entity
 * @param toKey the referring entity
 * @param relationTypeDesc the type of relationship
 */

Answer 2

Дополнительная подсказка: Netbeans может сделать это для вас:

public static function test($var1,$var2) {
    return $array;
}

Теперь напишите:

/**[press enter]
public static function test($var1,$var2) {
    return $array;
}

Тадаам:

/**
 * 
 * @param type $var1
 * @param type $var2
 * @return type
 */
public static function test($var1,$var2) {
    return $array;
}

Answer 3

Вам нужно 2 ** при открытии комментариев, чтобы Netbeans его распознал:

Должно быть

/**         
 *           
 */

не просто обычный комментарий

/*
 *
 */

Пример:

/**
 * function description
 *
 * @param *vartype* ***param1*** *description*
 * @param int param2 this is param two  
 * @return void  
 */

Netbeans автоматически добавляет имя функции

@ возврат не обязателен, но полезен

Answer 4

Я полагаю, что способ запустить ваш функциональный комментарий -

/**
 * addRelationship
 *
 * Adds a relationship between two entities using the given relation type.
 *
 * @param fromKey the original entity
 * @param toKey the referring entity
 * @param relationTypeDesc the type of relationship
 */

Обратите внимание на двойную звездочку, чтобы начать свой комментарий.Вы можете проверить это php documentor .

Answer 5

/**
 *
 * Adds a relationship between two entities using the given relation type.
 *
 * @since 2.1.1
 * @package coreapp
 * @subpackage entity
 * 
 * @param string $fromKey the original entity
 * @param mixed $toKey the referring entity
 * @param string relationTypeDesc the type of relationship
 * @return bool False if value was not updated and true if value was updated.
 */

Вы можете добавить, с какой версии, какого пакета, какого подпакета добавить тип параметров, то есть string, mixed, bool и что является возвращаемым значением.