Irish SEO,  Marketing & Webmaster Discussion

 

documenting php code functions

This is a discussion on documenting php code functions within the Coding Help forums, part of the Webmaster Help category; [deleted]...


Go Back   Irish SEO, Marketing & Webmaster Discussion > Webmaster Help > Coding Help

Register Forum Rules FAQDonate Calendar Search Today's Posts Mark Forums Read

  #1 (permalink)  
Old 25-07-2008, 02:31 PM
SMB.
 
Join Date: Oct 2006
Posts: 454
Nominated 0 Times in 0 Posts
TOTW/F/M Award(s): 0
3rigena will become famous soon enough
Default documenting php code functions

[deleted]

Last edited by 3rigena; 28-07-2008 at 05:57 PM..
Digg this Post!Add Post to del.icio.usBookmark Post in TechnoratiFurl this Post!Spurl this Post!Reddit! Wong this Post!
Reply With Quote
  #2 (permalink)  
Old 25-07-2008, 02:41 PM
louie's Avatar
Senior Member
 
Join Date: Jan 2006
Location: Dublin, Ireland
Posts: 2,204
Nominated 6 Times in 4 Posts
Nominated TOTW/F/M Award(s): 1
louie has much to be proud oflouie has much to be proud oflouie has much to be proud oflouie has much to be proud oflouie has much to be proud oflouie has much to be proud oflouie has much to be proud oflouie has much to be proud of
Send a message via Yahoo to louie Send a message via Skype™ to louie
Default

are you talking about
PHP Code:
// one line comment
/*
multiple lines comments
*/ 
Digg this Post!Add Post to del.icio.usBookmark Post in TechnoratiFurl this Post!Spurl this Post!Reddit! Wong this Post!
Reply With Quote
  #3 (permalink)  
Old 25-07-2008, 03:25 PM
paul's Avatar
ninja SEO
 
Join Date: Dec 2006
Location: .de
Posts: 1,251
Nominated 0 Times in 0 Posts
TOTW/F/M Award(s): 0
paul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud ofpaul has much to be proud of
Default

Then use something doxegen to make a nice little code manual. Plus there are extra types of comments you can put in that.
__________________
my sites :
irish poker / irish jobs / seo faq / advertise jobs free / green card / skiing
Digg this Post!Add Post to del.icio.usBookmark Post in TechnoratiFurl this Post!Spurl this Post!Reddit! Wong this Post!
Reply With Quote
  #4 (permalink)  
Old 25-07-2008, 03:27 PM
Coder
 
Join Date: Jul 2007
Location: Galway
Posts: 85
Nominated 0 Times in 0 Posts
TOTW/F/M Award(s): 0
davkell has much to be proud ofdavkell has much to be proud ofdavkell has much to be proud ofdavkell has much to be proud ofdavkell has much to be proud ofdavkell has much to be proud ofdavkell has much to be proud ofdavkell has much to be proud of
Default

You can see standards for phpDocumentor (open source auto-documentation tool for PHP code) are at this tutorial. They look similar to Java (from what I remember of Java!)
__________________
Not Work: My blog
Work: Website Design Galway
A little app: Twiteye.com (Application, software & service ideas from Twitter)
Digg this Post!Add Post to del.icio.usBookmark Post in TechnoratiFurl this Post!Spurl this Post!Reddit! Wong this Post!
Reply With Quote
  #5 (permalink)  
Old 26-07-2008, 12:05 PM
SMB.
 
Join Date: Oct 2006
Posts: 454
Nominated 0 Times in 0 Posts
TOTW/F/M Award(s): 0
3rigena will become famous soon enough
Default

[deleted]

Last edited by 3rigena; 28-07-2008 at 07:41 PM..
Digg this Post!Add Post to del.icio.usBookmark Post in TechnoratiFurl this Post!Spurl this Post!Reddit! Wong this Post!
Reply With Quote
Reply

Tags
code, documenting, functions, php

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On


Similar Threads

Thread Thread Starter Forum Replies Last Post
What is this code used for... ButtermilkJack Coding Help 2 07-05-2008 01:21 PM
Help with website - why code like this? ButtermilkJack Coding Help 9 28-01-2008 12:30 PM
Where did you learn to code? blacknight Webmaster Discussion 4 30-01-2006 08:33 AM


Sponsored links

Pepperjam Network
Paid On Results www.zanox.com


All times are GMT +1. The time now is 06:33 PM.


Powered by: vBulletin Version 3.8.2, Copyright ©2000 - 2009, Jelsoft Enterprises Limited.
Hosted in Ireland by Blacknight - Test your ISP |Irish Hosting Directory| Armchair.ie|Logo by Eden Web Design|Avatars by Afterglow |Latest Blog Entries | VPS HostingAd Management by RedTyger

Search Engine Friendly URLs by vBSEO 3.3.0

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51