Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code documentation #5

Open
ollytom opened this issue Jun 9, 2017 · 1 comment
Open

Code documentation #5

ollytom opened this issue Jun 9, 2017 · 1 comment
Labels

Comments

@ollytom
Copy link

ollytom commented Jun 9, 2017

I'm personally familiar with C and Golang style code documentation: section 3 manpages and godoc. But because of my considerable noob factor I can't seem to find a standard, simple way to write and maintain PHP docs.

The main info we need is the same as any C stdlib function or php function:

  • name
  • synopsis
  • description
  • parameters
  • return values
@ollytom ollytom added the bug label Jun 9, 2017
@afoster
Copy link
Member

afoster commented Jun 9, 2017

https://www.phpdoc.org/ is probably the industry standard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants