#69
  • Created on
    2008-02-15 17:52
  • Reported by
    rbencina
  • Status
    Accepted
  • Priority
    Normal (3)
  • Assigned to
    wspinelli
  • Milestone
    -
  • Plan Level
    -
  • Permission type
    Private
  • Due Date
    -

Attachments

Related Tickets

Add new subtask or bug
Edit

Merge Requests

Update coding standards and style guide and move to the Wiki

[DONE] Create a wiki page to document our coding standards. Start with this: http://www.portaudio.com/docs/proposals/014-StyleGuide.html
(Note that there are some display errors in http://www.portaudio.com/docs/proposals/014-StyleGuide.html since it embeds > and < without escaping them.)

New Wiki coding stanards page is here: ImplementationStyleGuidelines

[?DONE?] We currently have no standard for the formatting of comments.
  • Wiki now says C-Style comments. Do we need guidelines for multi-line comments?

[?DONE?] We have no documented or agreed standard for use of SVN (creating branches rather than breaking the trunk, etc).
Actually we now have:
User picture
  on 2011-02-07 04:29 *
By rbencina
Marked as STARTER. This would be a cut and paste job to a new Wiki page followed by application of wiki formatting to get it back to a similar format to the old pages.
User picture
  on 2012-01-27 01:15 *
By rbencina
TRAC migration: propagating ticket status from TRAC
User picture
  on 2015-06-13 15:14 *
By rbencina
Permission type changed from Private to Public
User picture
  on 2015-08-23 13:49 *
By wspinelli
Assigned to set to wspinelli
Status changed from New to Accepted
User picture
  on 2015-08-23 18:37 *
By wspinelli
The content from the old page http://www.portaudio.com/docs/proposals/014-StyleGuide.html has been moved to a new page with Assembla.
The page can be accessed here https://www.assembla.com/spaces/portaudio/wiki/ImplementationStyleGuidelines

I have done some small changes (added a reference to C-style comments, and fixed the name of the file where PA_DEBUG macro are located). Plus all code-related stuff has been inserted as inline code. Therefore all the text that was lost in the original page due to unescaped lt and gt should now be visible.

Maybe some additional information could be added with the minimum amount of Doxygen information required for each file??
User picture
  on 2015-09-06 10:14 *
By rbencina
@wspinelli Thank you! I have made a few minor edits and added a section on Doxygen comments. Would you mind taking a look at the Doxygen section and let me know what you think?

It would be nice if we could automate the formatting conformance and naming guidelines. I'm imagining something like:

  • Work out the exact astyle parameters that match our current formatting style. Run astyle and generate a diff.
  • Use doxygen to generate a symbol dumb (xml output mode) then slurp this into python and run a check for our naming rules.

Any thoughts?
User picture
  on 2015-09-06 10:43 *
By rbencina
Permission type changed from Public to Private
User picture
  on 2015-09-06 12:49 *
By rbencina
Missing doxygen tags are documented here:

https://www.assembla.com/spaces/portaudio/tickets/71
User picture
  on 2015-09-06 12:54 *
By rbencina
Description changed from [Trac: Originally assigned ... to Wiki page is here: https://...
User picture
  on 2015-09-06 12:55 *
By rbencina
Description changed from Wiki page is here: https://... to Wiki page is here: https://...
User picture
  on 2015-09-06 13:15 *
By rbencina
Description changed from Wiki page is here: https://... to [DONE] Create a wiki page t...
Restructured wiki heirarchy and added links to RulesForSvnCommitters and HowToUseCodeReview to DeveloperGuidelines.
User picture
  on 2015-09-06 13:42 *
By rbencina
Created #237, #238, #239, that should cover the fallout from adhering the style guidelines. The only remaining question is around how to handle multi-line comments.
User picture
  on 2015-09-06 20:38 *
By wspinelli
The multi-line format that you propose is good. I have added it to the Wiki page.

I had already checked the astyle command in fixfile.bat. I have seen the the style=ansi option is deprecated in the latest version of astyle avaiable

I will have a look at the astyle syntax to see how we can match the proposed coding style.