WordPress.org

Ready to get started?Download WordPress

Ideas

better code-documentation! please! (inline-documentation)

  1. Tobias Jordans
    Member

    12345

    please, developer: work on your code-dokumentation.

    it is such a pain always to read through the whole function to find out what is is used for...

    there really has to be a refactoring with a good code-documentation in it...

    the same goes to the file itself: what stuff is in which file? there is no explaining comment, no dokumentation...

    please go on the the wiki-inline-code-documentation-project that started but didnt get far...

    this also would make the codex much more usable since it doesnt need to be a inline-code-doc-replacement but can concentrate on the important description of how stuff is linked together and how concrete scenarios are solved.

    Posted: 7 years ago #
  2. NuclearMoose
    Member

    Excellent idea...been called for numerous times. However, it won't happen any time soon. It's been shot down every single time.

    Posted: 7 years ago #
  3. Matt Mullenweg
    Key Master

    12345

    Inline documentation patches have been included in 2.1 and any new ones will happily be accepted.

    Posted: 7 years ago #
  4. Tobias Jordans
    Member

    12345

    How can we contribute, Matt?
    I would if I knew that the work is seen somewhere.

    Posted: 7 years ago #
  5. foolswisdom
    Staff

    tobias, thank you for participating in WordPress! Create tickets and attach patches at http://trac.wordpress.org/

    Posted: 7 years ago #
  6. Tobias Jordans
    Member

    12345

    I had to look around for some time to find this page: http://asymptomatic.net/2005/12/03/2142/how-to-patch-wordpress/

    Thats the first place really describing how to contribute...

    Posted: 7 years ago #
  7. foolswisdom
    Staff

    tobias, glad you figured it out!

    Aside, that article by Owen has long been on the front page of our trac.

    Posted: 7 years ago #
  8. JeremyVisser
    Member

    12345

    The Codex is a wiki, editable by anyone. If anyone's to blame for it not being good enough, it's you (read: whoever's reading this post, including me).

    Posted: 6 years ago #
  9. Jen Mylo
    Key Master

    Jacob Santos busted ass getting heaps of inline documentation in 2.7. Closing this thread as implemented.

    Posted: 4 years ago #

RSS feed for this topic

Topic Closed

This topic has been closed to new replies.

  • Rating

    12345
    122 Votes
  • Status

    This idea has been implemented