Artemis
4.7.6

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. 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
  • 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 7d282120.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 4.7.6
Versions
latest
stable
4.7.6
4.7.5
4.7.4
4.7.3
4.7.2
4.7.1
4.7.0
4.6.4
4.6.3
4.6.2
4.6.1
4.6.0
4.5.2
4.5.1
4.5.0
4.4.6
4.4.5
4.4.4
4.4.3
4.4.2
4.4.1
4.4.0
4.3.10
4.2.12
doc-server-guidelines-null-index-issue
chore-exam-mode-documentation
chore-documentation-programming-exercises-setup
Downloads
On Read the Docs
Project Home
Builds