This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 207929 - Help action or hint for generating correct comments would be really appreciated
Summary: Help action or hint for generating correct comments would be really appreciated
Status: NEW
Alias: None
Product: php
Classification: Unclassified
Component: PHPDoc (show other bugs)
Version: 7.2
Hardware: PC Linux
: P3 normal (vote)
Assignee: Ondrej Brejla
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-01-30 18:21 UTC by Martin Fousek
Modified: 2016-09-22 15:01 UTC (History)
1 user (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Fousek 2012-01-30 18:21:43 UTC 
Product Version: NetBeans IDE 7.1 (Build 201112071828)

Way how to write correct comments to have them in CC is quite tough fight. :) I wanted to have method in CC so after some tips from Ondra and reading the PHPDoc I got to this form of comment:
* @method void addDateTimePicker() addDateTimePicker($name, $label, $cols = NULL, $maxLength = NULL) adds DateTimePicker control to the form

Anyway it's still wrong (can be really stupid issue - at least I have missing types of parameters).

I can examine that probably much more users would appreciate adding some checking hints for the PHP docs if it's doable or helper action for generating comments into the classes. 

So I would fill in dialog with the return type, method name, parameters and the description and the Doc would be created for me.
Comment 1 Martin Fousek 2012-01-30 18:28:58 UTC 
examine -> imagine :)