Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Submit feedback
  • Sign in
toolbox
toolbox
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
    • Locked Files
  • Issues 7
    • Issues 7
    • List
    • Boards
    • Labels
    • Milestones
  • Merge Requests 3
    • Merge Requests 3
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Commits
  • Issue Boards
  • Institute of Technical Acoustics (ITA)
  • toolboxtoolbox
  • Wiki
  • code conventions

code conventions

Last edited by Marco Berzborn Mar 03, 2017
Page history

Code Conventions

Functions and Classes inside the ITA-Toolbox should follow the following style guidelines:

  • ita_your_new_function,

  • itaYourNewClass.

  • Function and method names should only consist of lowercase letters, words separated by underscores. Classes definitions should not contain separating characters between words, but instead start every word with a capital letter while remaining letters have to be lower case.

  • Make sure that function, class and variable names are representative for their intended tasks and use cases.

  • In order to generate a new function you can use the function ita_newm to create a template m-file containing guidelines for the documentation, input parsing and the function body.

Clone repository
  • code conventions
  • faq
  • Home
More Pages

New Wiki Page

Tip: You can specify the full path for the new file. We will automatically create any missing directories.