
| Current Path : /var/www/web-klick.de/dsh/10_customer2017/1204__intel/OptiCM/lib/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/web-klick.de/dsh/10_customer2017/1204__intel/OptiCM/lib/ReadMe.ModuleTemplate.txt |
Each module in this directory should follow the following general structure:
--------------------------------------------------------------------------------
## @file <file name>
# @brief <one line description of the file's purpose>
# @detail <detailed description of the file (optional)>
package <package name>;
use strict;
use warnings;
use parent qw( <parent package> );
# Use Core & CPAN Modules
use File::Spec; # example only
# Use OO-OptiCm Modules (should be minimal)
use OptiCm::Engine::AppController;
use OptiCm::Notifications qw( <debug, info, etc...> );
# Use Legacy OptiCM Modules (only if absolutely necessary)
# class-global variables - to be avoided if at all possible
my $globalXYZ = ...;
# Initialisation routines
sub new {}
# Setters and getters
# Other methods
return __PACKAGE__; # or 1 if it's not a CLI command ;-)
--------------------------------------------------------------------------------