/usr/share/doc/seed-doc/conventions.html is in seed-doc 3.2.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Seed Coding Conventions</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link rel="stylesheet" href="style.css" type="text/css" charset="utf-8" />
<script type="text/javascript" src="sh.js"></script>
<script type="text/javascript" src="sh_js.js"></script>
<link type="text/css" rel="stylesheet" href="sh.css" />
<style type="text/css">
div.section
{
font-weight: bold;
}
</style>
</head>
<body onload="sh_highlightDocument();">
<div id="header">Seed Coding Conventions</div>
<div id="subheader">v.3.2.0</div>
<div class="section">Naming and Capitalization</div>
<p>
<ul>
<li>Always use UpperCamelCase for the names of classes.</li>
<li>Always use underscore_case for the names of variables and functions.</li>
</ul>
</p>
<div class="section">Encapsulation</div>
<p>
<ul>
<li>Prefer functions to properties, for performance's sake.</li>
<li>Place all code for a class <em>within</em> its init function. Look at the tutorial Web Browser for an example.</li>
</ul>
</p>
</body>
</html>
|