Convention for JavaScript Packages and Classes: Difference between revisions

From Chorke Wiki
Jump to navigation Jump to search
(Created page with "== Overview == Like any other '''Open Source Community Project''', we are aware about the coding convention. We have to follow '''Best Practice''' and the '''Community Standar...")
 
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Overview ==
== Overview ==
Like any other '''Open Source Community Project''', we are aware about the coding convention. We have to follow '''Best Practice''' and the '''Community Standard'''. Beside that we should respect [http://chorke.org '''Chorke, Inc.''']'s own standard. Which one never conflict with others rather it will express our '''integrity''' and the '''beauty''' of contribution.  By which our contributor could share and understand their contribution with each others. It will help us to increase the transparency and logic building.
Like any other '''Open Source Community Project''', [http://chorke.org '''Chorke, Inc.'''] is aware about the coding convention. We have to follow '''Best Practice''' and the '''Community Standard'''. Beside that we should respect [http://chorke.org '''Chorke, Inc.''']'s own standard. Which one never conflict with others rather it will express our '''integrity''' and the '''beauty''' of contribution.  By which our contributor could share and understand their contribution with each others. It will help us to increase the transparency of our business.  [http://chorke.org '''Chorke, Inc.''']'  and it's affiliate maintains by following domain:
 
{| class="wikitable sortable"
|-
! FQDN !! Root !! Short || Elaboration || Wiki
|-
|  [http://shahed.biz shahed.biz] || biz || SHa || Shahed, Inc. (biz) || SHa Pedia
|-
|  [http://chorke.com chorke.com] || com || CKi || Chorke, Inc. (com) || CKi Pedia
|-
|  [http://chorke.org chorke.org] || org || CKo || Chorke, Inc. (org) || CKo Pedia
|}
 
The [http://shahed.biz  '''Shahed, Inc.''']  is the parent concern of '''Chorke, Inc.'''  Where [http://chorke.com '''chorke.com'''] & [http://chorke.org '''chorke.org''']' are the sister. Main goal of [http://chorke.org '''chorke.org'''] to focus on the community process.
 
== Shahed, Inc (.biz) ==
<syntaxhighlight lang="js">
/**
* @class    Shahed
* @package  Default
* @public
* @static
*/
var Shahed=Shahed||(function(win){
    var $,
        $self  ={},
        $static=$self;
    Shahed=function(){};
 
    $=new Shahed();
    //$=$.define($,$static);
    win&&(win.Shahed=win.Shahed||$);
    return $;
}(window)),
SHa=SHa||(function(win, $){
    win&&(win.SHa=win.SHa||$);
    return $;
}(window, Shahed)),
SH=SH||(function(win, $){
    win&&(win.SH=win.SH||$);
    return $;
}(window, SHa));
</syntaxhighlight>
 
== Chorke, Inc(.com) ==
<syntaxhighlight lang="js">
/**
* @class    Chorke
* @package  Default
* @public
* @static
*/
var Chorke=Chorke||(function(win){
    var $,
        $self  ={},
        $static=$self;
    Chorke=function(){};
 
    $=new Chorke();
    //$=$.define($,$static);
    win&&(win.Chorke=win.Chorke||$);
    return $;
}(window)),
CKi=CKi||(function(win, $){
    win&&(win.CKi=win.CKi||$);
    return $;
}(window, Chorke)),
CK=CK||(function(win, $){
    win&&(win.CK=win.CK||$);
    return $;
}(window, CKi));
</syntaxhighlight>
 
== Chorke, Inc(.org) ==
<syntaxhighlight lang="js">
/**
* @class    Chorke
* @package  Default
* @public
* @static
*/
var Chorke=Chorke||(function(win){
    var $,
        $self  ={},
        $static=$self;
    Chorke=function(){};
 
    $=new Chorke();
    //$=$.define($,$static);
    win&&(win.Chorke=win.Chorke||$);
    return $;
}(window)),
CKo=CKo||(function(win, $){
    win&&(win.CKo=win.CKo||$);
    return $;
}(window, Chorke)),
CK=CK||(function(win, $){
    win&&(win.CK=win.CK||$);
    return $;
}(window, CKo));
</syntaxhighlight>
 
==Example==
{|
| valign="top" |
<source lang="js" highlight="9-14,17">
var Chorke=Chorke||(function(Chorke,$me){
    $me=new Chorke();
    $me.$package='';
    $me.$namespace='';
    $me.$class='Chorke';
    return $me;
}(function(){}));
 
;Chorke.Academia||(function($,Academia,$me){
    $me=new Academia();
    $me.$package=$.$class;
    $me.$namespace=$.$class;
    $me.$class='Academia';
 
    $.Academia=$me;
    return $me;
}(Chorke,function(){}));
</source>
 
| valign="top" |
<source lang="js" highlight="9-14,17">
var Chorke=Chorke||(function(Chorke,$me){
    $me=new Chorke();
    $me.$package='';
    $me.$namespace='';
    $me.$class='Chorke';
    return $me;
}(function(){}));
 
;Chorke.Academia||(function($,$me){
 
    $me.$package=$.$class;
    $me.$namespace=$.$class;
    $me.$class='Academia';
 
    $.Academia=$me;
    return $me;
}(Chorke,{}));
</source>
 
| valign="top" |
<source lang="js" highlight="9-14,17">
var Chorke=Chorke||(function(Chorke,$me){
    $me=new Chorke();
    $me.$package='';
    $me.$namespace='';
    $me.$class='Chorke';
    return $me;
}(function(){}));
 
;Chorke.Academia||(function($,$me){
    $me={
        $package:$.$class,
        $namespace:$.$class,
        $class:'Academia'
    };
    $.Academia=$me;
    return $me;
}(Chorke));
</source>
|}
 
==References==
* [[Convention for JavaScript Packages and Classes]]
* [[Convention for Cascading Style Sheets]]
* [[Convention for Java Web Start Project]]
* [[Convention for Database Tables]]
* [[Convention for Port]]
* [[Convention for API]]

Latest revision as of 09:55, 26 October 2021

Overview

Like any other Open Source Community Project, Chorke, Inc. is aware about the coding convention. We have to follow Best Practice and the Community Standard. Beside that we should respect Chorke, Inc.'s own standard. Which one never conflict with others rather it will express our integrity and the beauty of contribution. By which our contributor could share and understand their contribution with each others. It will help us to increase the transparency of our business. Chorke, Inc.' and it's affiliate maintains by following domain:

FQDN Root Short Elaboration Wiki
shahed.biz biz SHa Shahed, Inc. (biz) SHa Pedia
chorke.com com CKi Chorke, Inc. (com) CKi Pedia
chorke.org org CKo Chorke, Inc. (org) CKo Pedia

The Shahed, Inc. is the parent concern of Chorke, Inc. Where chorke.com & chorke.org' are the sister. Main goal of chorke.org to focus on the community process.

Shahed, Inc (.biz)

/**
 * @class     Shahed
 * @package   Default
 * @public
 * @static
 */
var Shahed=Shahed||(function(win){
    var $,
        $self  ={},
        $static=$self;
    Shahed=function(){};

    $=new Shahed();
    //$=$.define($,$static);
    win&&(win.Shahed=win.Shahed||$);
    return $;
}(window)),
SHa=SHa||(function(win, $){
    win&&(win.SHa=win.SHa||$);
    return $;
}(window, Shahed)),
SH=SH||(function(win, $){
    win&&(win.SH=win.SH||$);
    return $;
}(window, SHa));

Chorke, Inc(.com)

/**
 * @class     Chorke
 * @package   Default
 * @public
 * @static
 */
var Chorke=Chorke||(function(win){
    var $,
        $self  ={},
        $static=$self;
    Chorke=function(){};

    $=new Chorke();
    //$=$.define($,$static);
    win&&(win.Chorke=win.Chorke||$);
    return $;
}(window)),
CKi=CKi||(function(win, $){
    win&&(win.CKi=win.CKi||$);
    return $;
}(window, Chorke)),
CK=CK||(function(win, $){
    win&&(win.CK=win.CK||$);
    return $;
}(window, CKi));

Chorke, Inc(.org)

/**
 * @class     Chorke
 * @package   Default
 * @public
 * @static
 */
var Chorke=Chorke||(function(win){
    var $,
        $self  ={},
        $static=$self;
    Chorke=function(){};

    $=new Chorke();
    //$=$.define($,$static);
    win&&(win.Chorke=win.Chorke||$);
    return $;
}(window)),
CKo=CKo||(function(win, $){
    win&&(win.CKo=win.CKo||$);
    return $;
}(window, Chorke)),
CK=CK||(function(win, $){
    win&&(win.CK=win.CK||$);
    return $;
}(window, CKo));

Example

var Chorke=Chorke||(function(Chorke,$me){
    $me=new Chorke();
    $me.$package='';
    $me.$namespace='';
    $me.$class='Chorke';
    return $me;
}(function(){}));

;Chorke.Academia||(function($,Academia,$me){
    $me=new Academia();
    $me.$package=$.$class;
    $me.$namespace=$.$class;
    $me.$class='Academia';

    $.Academia=$me;
    return $me;
}(Chorke,function(){}));
var Chorke=Chorke||(function(Chorke,$me){
    $me=new Chorke();
    $me.$package='';
    $me.$namespace='';
    $me.$class='Chorke';
    return $me;
}(function(){}));

;Chorke.Academia||(function($,$me){

    $me.$package=$.$class;
    $me.$namespace=$.$class;
    $me.$class='Academia';

    $.Academia=$me;
    return $me;
}(Chorke,{}));
var Chorke=Chorke||(function(Chorke,$me){
    $me=new Chorke();
    $me.$package='';
    $me.$namespace='';
    $me.$class='Chorke';
    return $me;
}(function(){}));

;Chorke.Academia||(function($,$me){
    $me={
        $package:$.$class,
        $namespace:$.$class,
        $class:'Academia'
    };
    $.Academia=$me;
    return $me;
}(Chorke));

References