Thread: Code management

    #1
  1. A Change of Season
    Devshed Expert (3500 - 3999 posts)

    Join Date
    Mar 2004
    Location
    Next Door
    Posts
    3,558
    Rep Power
    221

    Code management


    Hi;

    For users to use the system, along with text manual, the best way is screencast no doubt.

    However, I realise I need to make docs for my own ref as well. In case I wanna go back, make updates.

    I don't mean code comments. I usually do something like this:

    LINK ===> this <====. See the darker table.

    Still, it's not great. I mean it's my language and makes my life much easier but I need tips to improve my relationship with my code.

    If you have a sample to share, please do.

    Thoughts, comments, ideas?

    Thanks
  2. #2
  3. Lord of the Dance
    Devshed Specialist (4000 - 4499 posts)

    Join Date
    Oct 2003
    Posts
    4,181
    Rep Power
    2011
    It looks like you are creating your own kind of a REST API service.
    Have you tried to search for some examples on this? For example:
    https://bocoup.com/blog/documenting-your-api
    (Which is not far away from what you already have).
  4. #3
  5. A Change of Season
    Devshed Expert (3500 - 3999 posts)

    Join Date
    Mar 2004
    Location
    Next Door
    Posts
    3,558
    Rep Power
    221
    Looks good thanks.

IMN logo majestic logo threadwatch logo seochat tools logo