Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A Android-IMSI-Catcher-Detector
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 162
    • Issues 162
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 5
    • Merge requests 5
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • CellularPrivacy
  • Android-IMSI-Catcher-Detector
  • Wiki
  • Style Guide

Style Guide · Changes

Page history
Added important thoughts from @larsgrefer authored Dec 08, 2015 by Security: Pwned's avatar Security: Pwned
Show whitespace changes
Inline Side-by-side
Style-Guide.md
View page @ 7d242592
...@@ -98,6 +98,31 @@ As much as we enjoy your contributions, please keep a high code-quality! ...@@ -98,6 +98,31 @@ As much as we enjoy your contributions, please keep a high code-quality!
public protected private abstract static final transient volatile synchronized native strictfp public protected private abstract static final transient volatile synchronized native strictfp
``` ```
Thoughts about some parts of the (javadoc-) comments:
- `Description:`
- Don't prefix the description with `Description:` in order to be more javadoc-like
- `Issues:` and `Todos:`
- Don't track this in comments
- Better track them here at github (or another bugtracker)
- `Changelog:`
- Don't track this in comments
- We have `git log -- <file>` and `git blame <file>` for that
- In general the javadoc comments should be more javadoc like:
- Use HTML tags like `<p>` and `<a>`
- Use things like:
- `@see`
- `@author`
- `{@link <method|class|field>}`
About discussions:
- Don't keep discussion in source code comments
- Use line comments at github for that
About source code comments vs wiki:
- Use source code comments for (technical) information/documentation about a particular class/method/field
- Use the wiki for overviews, manuals and so on
--- ---
#### Formats #### Formats
......
Clone repository

Project Information

  • Unmasked Spies
  • Glossary of Terms
  • General Overview
  • Technical Overview

Getting started

  • Building
  • Requirements
  • Installation
  • Permissions
  • Status Icons

Developers

  • Development Status
  • Testing Devices
  • Contributing
  • Style Guide
  • Resources
  • Privacy

Navigation Menus

  • Disclaimer
  • Main Screen
  • Navigation Drawer
  • Preferences
  • About AIMSICD

Important Functions

  • Cell Monitoring
  • Current Threat Level
  • AT Command Interface
  • Database Viewer
  • Antenna Map Viewer
  • Special SMS

Support

  • FAQ
  • Contact
  • Problems
  • Donations

Gimme moar!

  • Media Material
  • Press Releases
  • Recommendations
  • Similar Projects