web-dev-qa-db-ja.com

Netbeans PHPで関数のドキュメントを追加するにはどうすればよいですか?

私は以下を試しました、

/*
 * 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が見つからないと表示されます。

alt text

これをNetBeans PHPで機能させる方法に関するアイデアはありますか?

更新:

以下は、NetBeansで機能する更新された構文ですPHP-

/** 
 * 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) {
31

最初の行にアスタリスク*がありません:試してください

/**
 * 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
 */
39
Pekka 웃

追加のヒント: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;
}
19

Netbeansがそれを認識するには、コメントの冒頭に2 **が必要です。

する必要があります

/**         
 *           
 */

通常のコメントだけではない

/*
 *
 */

例:

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

Netbeansは自動的に関数名を追加します

@returnはオプションですが便利です

6
Paulo

関数コメントを始める方法は

/**
 * 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

5
A Salcedo
/**
 *
 * 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.
 */

バージョン、パッケージ、サブパッケージ、パラメーターのタイプ(文字列、混合、ブール、戻り値など)を追加できます。

2
toha