Artemis
4.9.0

User Guide

  • Exercises
  • Exam Mode

Contributor Guide

  • Setup Guide
  • Coding and design guidelines
    • Server
    • Client
    • Database Relationships
  • System Design
  • Using local user management
  • Guided Tour
  • Test Servers

Administration Guide

  • User Registration
Artemis
  • »
  • Coding and design guidelines
  • Edit on GitHub

Coding and design guidelines¶

Coding and design guidelines

  • Server
    • 0. Folder structure
    • 1. Naming convention
    • 2. Single responsibility principle
    • 3. Small methods
    • 4. Duplication
    • 5. Variables and methods declaration
    • 6. Structure your code correctly
    • 7. Database
    • 8. Comments
    • 9. Utility
    • 10. Auto configuration
    • 11. Keep your @RestController’s clean and focused
    • 12. Dependency injection
    • 13. Keep it simple and stupid
    • 14. File handling
    • 15. General best practices
  • Client
    • 0. General
    • 1. Names
    • 2. Components
    • 3. Types
    • 4. null and undefined
    • 5. General Assumptions
    • 6. Comments
    • 7. Strings
    • 8. Style
    • 9. Testing
    • 10. Preventing Memory Leaks
      • What are memory leaks?
      • What are common reasons for memory leaks?
      • What are ways to identify memory leaks?
    • 11. Defining Routes and Breadcrumbs
  • Database Relationships
    • 1. Retrieving and Building Objects
    • 2. Relationships
    • 2. Cascade Types
    • Best Practices
    • Solutions for known issues
Next Previous

© Copyright 2020, Technical University of Munich, Chair for Applied Software Engineering Revision 9c4d039f.

Built with Sphinx using a theme provided by Read the Docs.