• 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
User Documentation

#2
(08-07-2016, 10:34 PM)prezire Wrote: Is it possible to enhance the user documentation by providing datatypes to method signatures? It's easier to see everything in a glance that you don't need to find what and where things are.

See examples from:
Java http://icecream.me/5bd24c8336499692e990a7de84e4e8ba
PHP http://icecream.me/44998e053b59b2bbf505c86ded89afee
.NET framework http://icecream.me/26cfe49c08b2285ff859b5e99bf60369

and so forth.

Unlike Java (and not sure about .NET), PHP functions don't necessarily return a declared datatype. Take stripos for example:

http://php.net/manual/en/function.stripos.php

In CI, this happens a lot. Consider the Input class methods for getting values from GET or POST vars. Maybe it could help the docs to know what the return type is, but if you've really read the entire user guide, do you really still need that?
Reply


Messages In This Thread
User Documentation - by prezire - 08-07-2016, 10:34 PM
RE: User Documentation - by skunkbad - 08-07-2016, 10:58 PM
RE: User Documentation - by prezire - 08-08-2016, 03:58 AM
RE: User Documentation - by Narf - 08-08-2016, 04:09 AM
RE: User Documentation - by prezire - 08-08-2016, 05:30 AM
RE: User Documentation - by Narf - 08-09-2016, 04:07 AM
RE: User Documentation - by prezire - 08-09-2016, 04:09 PM
RE: User Documentation - by Narf - 08-10-2016, 02:14 AM
RE: User Documentation - by prezire - 08-10-2016, 07:01 AM
RE: User Documentation - by Narf - 08-10-2016, 08:00 AM
RE: User Documentation - by ciadmin - 08-09-2016, 08:23 PM
RE: User Documentation - by prezire - 08-10-2016, 07:10 AM
RE: User Documentation - by prezire - 08-10-2016, 09:36 AM
RE: User Documentation - by Michus - 08-10-2016, 05:07 PM
RE: User Documentation - by prezire - 08-10-2016, 09:52 PM
RE: User Documentation - by ridho - 08-12-2016, 02:42 AM
RE: User Documentation - by kilishan - 08-12-2016, 11:43 AM
RE: User Documentation - by prezire - 08-13-2016, 05:09 AM

Digg   Delicious   Reddit   Facebook   Twitter   StumbleUpon  


  Theme © 2014 iAndrew  
Powered By MyBB, © 2002-2020 MyBB Group.