Difference between revisions of "Official:Code guidelines and formatting conventions"

From Official Kodi Wiki
Jump to navigation Jump to search
m
 
Line 2: Line 2:
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules. For historic reason the current code doesn't always follow these guidelines however any new code should certainly follow them.
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules. For historic reason the current code doesn't always follow these guidelines however any new code should certainly follow them.


These coding guidelines and formatting conventions are part of our Doxygen documentation which can be generated from code. For easy viewing we also made these guidelines available online https://codedocs.xyz/xbmc/xbmc/code_guidelines.html
These coding guidelines and formatting conventions are part of our Doxygen documentation which can be generated from code. For easy viewing we also made these guidelines available online at https://github.com/xbmc/xbmc/blob/master/docs/CODE_GUIDELINES.md .
 


[[Category:Development]]
[[Category:Development]]

Latest revision as of 14:53, 11 February 2020

Home icon grey.png   ▶ Development ▶ Code guidelines and formatting conventions

These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules. For historic reason the current code doesn't always follow these guidelines however any new code should certainly follow them.

These coding guidelines and formatting conventions are part of our Doxygen documentation which can be generated from code. For easy viewing we also made these guidelines available online at https://github.com/xbmc/xbmc/blob/master/docs/CODE_GUIDELINES.md .