Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Talk:Coding style: Difference between revisions

From MoodleDocs
mNo edit summary
m ((keeping talk page clean))
 
(98 intermediate revisions by 17 users not shown)
Line 1: Line 1:
Should we enforce the PHP5 constructor __construct() instead of $classname() [[User:Nicolas Connault|Nicolas Connault]] 19:55, 19 May 2009 (UTC)
<p class="note">Note: Please avoid using this talk page to propose changes to the coding style. Instead [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12132&summary=coding%20style%20change file a coding style bug]. See the forum discussion [http://moodle.org/mod/forum/discuss.php?d=202406 Using Moodle: Proposing changes to moodle coding style] for more details.</p>
:+1. I think we agreed about that some time ago (when igniting some 2.0 developments) --[[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 00:03, 20 May 2009 (UTC)
----
About comments... I have been using since ages ago "///" with outer alignment (I think that it was caused by some agreement long time ago, not my decision), for example:
 
<code php>
function check_moodle_environment(..., ..., ..., ...) {
 
    $status = true;
 
/// This are cached per request
    static $result = true;
    static $env_results;
    static $cache_exists = false;
 
/// if we have results cached, use them
    if ($cache_exists) {
        $environment_results = $env_results;
/// No cache exists, calculate everything
    } else {
    /// Get the more recent version before the requested
        if (!$version = get_latest_version_available($version, $env_select)) {
            $status = false;
        }
        ....
        ....
</code>
Is that allowed, or only the "//" with inner alignment as commented at [[Coding style#Inline comments|inline comments]] --[[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 00:03, 20 May 2009 (UTC)

Latest revision as of 14:49, 30 September 2016

Note: Please avoid using this talk page to propose changes to the coding style. Instead file a coding style bug. See the forum discussion Using Moodle: Proposing changes to moodle coding style for more details.