vb.org Archive - View Single Post - Biggest coding project ever

Quote:

Originally Posted by filburt1

Speaking independently from my moderator position, the documentation is terrible within the code. Not only do nearly all of the functions lack any documentation, but the ones that have it have incorrect function names and don't document any of their arguments or the return value. Even the variable names don't help much.

I would pay a significant extra for a developer edition of a vB license that included proper PHPDoc-formatted (similar to PHPDoc) comments for each function. It would have cut my development time for vBMS and for future projects in half.

I couldn't agree more, the documentation within the code is terrible as it is.

X vBulletin 3.8.12 by vBS Debug Information
Template Usage: (1)SHOWTHREAD_SHOWPOST (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (1)bbcode_quote (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)post_thanks_box (1)post_thanks_button (1)post_thanks_javascript (1)post_thanks_navbar_search (1)post_thanks_postbit_info (1)postbit (1)postbit_onlinestatus (1)postbit_wrapper (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit reputationlevel showthread	Included Files: ./showpost.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/functions_bigthree.php ./includes/class_postbit.php ./includes/class_bbcode.php ./includes/functions_reputation.php ./includes/functions_post_thanks.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_postinfo_query fetch_postinfo fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete showpost_start bbcode_fetch_tags bbcode_create postbit_factory showpost_post postbit_display_start post_thanks_function_post_thanks_off_start post_thanks_function_post_thanks_off_end post_thanks_function_fetch_thanks_start post_thanks_function_fetch_thanks_end post_thanks_function_thanked_already_start post_thanks_function_thanked_already_end fetch_musername postbit_imicons bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete postbit_display_complete post_thanks_function_can_thank_this_post_start showpost_complete
Messages:

X vBulletin 3.8.12 by vBS Debug Information

Page Generation 0.00988 seconds
Memory Usage 1,763KB
Queries Executed 11 (?)

More Information

Template Usage:

(1)SHOWTHREAD_SHOWPOST
(1)ad_footer_end
(1)ad_footer_start
(1)ad_header_end
(1)ad_header_logo
(1)ad_navbar_below
(1)bbcode_quote
(1)footer
(1)gobutton
(1)header
(1)headinclude
(6)option
(1)post_thanks_box
(1)post_thanks_button
(1)post_thanks_javascript
(1)post_thanks_navbar_search
(1)post_thanks_postbit_info
(1)postbit
(1)postbit_onlinestatus
(1)postbit_wrapper
(1)spacer_close
(1)spacer_open

Phrase Groups Available:

global
postbit
reputationlevel
showthread

Included Files:

./showpost.php
./global.php
./includes/init.php
./includes/class_core.php
./includes/config.php
./includes/functions.php
./includes/class_hook.php
./includes/modsystem_functions.php
./includes/functions_bigthree.php
./includes/class_postbit.php
./includes/class_bbcode.php
./includes/functions_reputation.php
./includes/functions_post_thanks.php

Hooks Called:

init_startup
init_startup_session_setup_start
init_startup_session_setup_complete
cache_permissions
fetch_postinfo_query
fetch_postinfo
fetch_threadinfo_query
fetch_threadinfo
fetch_foruminfo
style_fetch
cache_templates
global_start
parse_templates
global_setup_complete
showpost_start
bbcode_fetch_tags
bbcode_create
postbit_factory
showpost_post
postbit_display_start
post_thanks_function_post_thanks_off_start
post_thanks_function_post_thanks_off_end
post_thanks_function_fetch_thanks_start
post_thanks_function_fetch_thanks_end
post_thanks_function_thanked_already_start
post_thanks_function_thanked_already_end
fetch_musername
postbit_imicons
bbcode_parse_start
bbcode_parse_complete_precache
bbcode_parse_complete
postbit_display_complete
post_thanks_function_can_thank_this_post_start
showpost_complete

Messages:

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.00988 seconds Memory Usage 1,763KB Queries Executed 11 (?)
More Information
Template Usage: (1)SHOWTHREAD_SHOWPOST (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (1)bbcode_quote (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)post_thanks_box (1)post_thanks_button (1)post_thanks_javascript (1)post_thanks_navbar_search (1)post_thanks_postbit_info (1)postbit (1)postbit_onlinestatus (1)postbit_wrapper (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit reputationlevel showthread	Included Files: ./showpost.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/functions_bigthree.php ./includes/class_postbit.php ./includes/class_bbcode.php ./includes/functions_reputation.php ./includes/functions_post_thanks.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_postinfo_query fetch_postinfo fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete showpost_start bbcode_fetch_tags bbcode_create postbit_factory showpost_post postbit_display_start post_thanks_function_post_thanks_off_start post_thanks_function_post_thanks_off_end post_thanks_function_fetch_thanks_start post_thanks_function_fetch_thanks_end post_thanks_function_thanked_already_start post_thanks_function_thanked_already_end fetch_musername postbit_imicons bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete postbit_display_complete post_thanks_function_can_thank_this_post_start showpost_complete
Messages: