Author Topic: No Doc Comments in Perl  (Read 2871 times)

zammazingo

  • Community Member
  • Posts: 21
  • Hero Points: 1
No Doc Comments in Perl
« on: October 08, 2008, 05:57:25 am »
Hi,

I am using SE linux 13.2 with the latest patch.
For some reason doc comments tab under perl is in grey color. I can not enable them.
I could not figure out why. Any comments? They are working well under C/C++.

I can send a screen shot if needed.
Thanks.

zammazingo

  • Community Member
  • Posts: 21
  • Hero Points: 1
Re: No Doc Comments in Perl
« Reply #1 on: October 15, 2008, 01:28:43 am »
Hi,

Can somebody please confirm if this is the normal behavior?
Or does it happen to everyone with perl in their system?
Thanks alot. I really appreciate your help.


chrisant

  • Senior Community Member
  • Posts: 1410
  • Hero Points: 131
Re: No Doc Comments in Perl
« Reply #2 on: October 15, 2008, 01:34:38 am »
Grayed out in SE Win 13.0.2.

Sandra

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 754
  • Hero Points: 35
Re: No Doc Comments in Perl
« Reply #3 on: October 15, 2008, 03:31:33 pm »
Right now, we don't support doc comments for Perl.  That's mostly due to the fact that Perl 5 doesn't really have multi-line comments.  However, we could work with these limitations. 

The simplest approach would be to just insert several lines of single-line comments.  Some of our current expansions do already work this way.  If you did this, then you'd get automatic tool tips inside SlickEdit.  We could also use POD notation.

Since you're here and thinking about this already, how would you want this to work?  What sort of end-result would you want out of a Perl doc comment expansion?  Are you wanting to generate documentation using a particular tool (e.g. pod2text, pod2html) or would you just like to have the SlickEdit tooltips?

Thanks for the feedback!

zammazingo

  • Community Member
  • Posts: 21
  • Hero Points: 1
Re: No Doc Comments in Perl
« Reply #4 on: October 17, 2008, 05:11:59 am »
Hi Sandra,

Thank you so much for your answer. Unfortunately, i am not a Perl guru and i also don't know much about POD notation.

What i was trying to do was something as simple as :

###[enter]

will expand to :

################################################################################################################################
#
# FUNCTION : FUNCTION_PROTOTYPE
#
# INPUT PARAMETERS :
#       NONE
#
# OUTPUT PARAMETERS :
#       NONE
#
# GLOBAL VARIABLES :
#       NONE
#
# RETURN VALUE :
#       NONE
#       
# DESCRIPTION :
#       NONE
#
# EXAMPLE :
#       NONE
#       
################################################################################################################################


or something along those lines.
But now you mentioned POD notation, i feel curios :-).
I will try to update the thread in couple of days after i check POD notation.
Thank you so much for your time and reply.