- android - RelativeLayout 背景可绘制重叠内容
- android - 如何链接 cpufeatures lib 以获取 native android 库?
- java - OnItemClickListener 不起作用,但 OnLongItemClickListener 在自定义 ListView 中起作用
- java - Android 文件转字符串
我需要在少数几个文件中评论大量信息,当我在 Google 和 Stack Overflow 中查看时,当我需要评论时,我会继续找到符合编码标准的结果标准。我的编码符合大多数编码标准,但涉及到注释时除外。
下面的例子是什么?
<?
// Beginning of file comments
require( 'filename.php' ); // Require or include, with filename
public class Test { } // Class without constructor
public class Test // Class with constructor, if different from above
{
public function __constructor() { } // Constructor, no parameters
public function __constructor(var1, var2) { } constructor, with parameters
public function func1() { } // Function, no parameters
public function func2($var1, $var2) { } // Function, with parameters
public function func3( $optional = '' ) { } // Function, optional parameters
private function func4() { } // Private function, if different from above
public static staticfunc1() { } // Public static function, if different from above
public function returnfunc1(var1, var2) // Tunction, with return value
{
return var1 + var2; // Return statement, dynamic
}
public function returnfunc2() // Function, with unchanging return value, if different from above
{
return 1; // Return statement, unchanging, if different from above
}
public function fullfunc1() // Declaration, calling and assignment, in function
{
$var1; // Variable declaration
$arr1 = array(); // Array declaration, if different from above
$var2 = dirname( __FILE__ ) . '/file.ext'; // Variable assignment
$this->var1 = $path . '_'; // Class variable assignment
ob_start(); // Function call
$this->func1(); // Class function call
ob_end_clean();
foreach($arr as $key => $val) { } // 'foreach' and 'for' loops
}
public $var1; // Public variable
private $var2; // Private variable, if different from above
}
// Ending of file comments?
?>
了解正确的风格很重要。它可以帮助其他人了解您的代码是如何工作的,以及如果您不在场解释代码,将来如何使用它。
最佳答案
总的来说,PHP 似乎有很多不同的风格指南...
但总的来说,关于注释要记住的一点是……您可能不想注释代码中的每一行。相反,尝试使您的代码可读1(按原样。)并在您真正需要其他人理解您的代码的作用时(主要是)发表评论。
1 http://www.codinghorror.com/blog/2008/07/coding-without-comments.html
关于PHP 注释标准,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9067094/
我最近在读 CSAPP。在 10.9 节中,它说标准 I/O 不应该与 socket 一起使用,原因如下: (1) The restrictions of standard I/O Restricti
似乎是一个足够标准的问题,可以保证解决方案中的标准设计: 假设我想在文件中写入 x+2(或更少)个字符串。 x 字符串构成一个部分的内容,这两个字符串构成该部分的页眉和页脚。要注意的是,如果内容中没有
代码版本管理 在项目中,代码的版本管理非常重要。每个需求版本的代码开发在版本控制里都应该经过以下几个步骤。 在master分支中拉取该需求版本的两个分支,一个feature分支,
我有以下sql查询,我需要获取相应的hibernate条件查询 SELECT COUNT(DISTINCT employee_id) FROM erp_hr_payment WHERE payment
所以我正在编写一些代码,并且最近遇到了实现一些 mixin 的需要。我的问题是,设计混音的正确方法是什么?我将使用下面的示例代码来说明我的确切查询。 class Projectile(Movable,
我的环境变量包含如下双引号: $echo $CONNECT_SASL_JAAS_CONFIG org.apache.kafka.common.security.plain.PlainLoginModu
示例: /** * This function will determine whether or not one string starts with another string. * @pa
有没有办法在 Grails 中做一个不区分大小写的 in 子句? 我有这个: "in"("name", filters.tags) 我希望它忽略大小写。我想我可以做一个 sqlRestriction
我搜索了很长时间,以查找将哪些boost库添加到std库中,但是我只找到了一个新库的完整列表(如此处:http://open-std.org/jtc1/sc22/wg21/docs/library_t
我已经通过使用这个肮脏的黑客解决了我的问题: ' Filter managerial functions ActiveSheet.Range("$A$1:$BW$2211").Auto
因此,我很难理解我需要遵循的标准,以便我的 Java 程序能够嵌入 HTML。我是否只需将我的主类扩展到 Applet 类,或者我还需要做更多的事情吗?另外,在我见过的每个 Applet 示例中,它都
我对在 Hibernate 中使用限制有疑问。 我必须创建条件,设置一些限制,然后选择日期字段最大值的记录: Criteria query = session.createCriteria(Stora
我有标准: ICriteria criteria = Session.CreateCriteria() .SetFetchMode("Entity1", FetchMo
我很难编写条件来选择所有子集合或孙集合为空的实体。我可以将这些作为单独的条件来执行,但我无法将其组合成一个条件。 类结构: public class Component { p
@Entity class A { @ManyToMany private List list; ... } @Entity class B { ... } 我想使用条件(不是 sql 查询)从 A
我的数据库中有以下表结构: Table A: Table B: Table C: _______________
请帮助我: 我有下一张 table : 单位 ID 姓名 用户 ID 姓名 利率 单位 ID 用户 ID 我不明白如何从 SQL 创建正确的条件结构: 代码: SELECT * FROM Unit W
我正在构建一个包含项目的网站,每个项目都有一个页面,例如: website.com/book/123 website.com/film/456 website.com/game/789 每个项目都可以
我需要使用两个属性的组合来过滤结果列表。一个简单的 SQL 语句如下所示: SELECT TOP 10 * FROM Person WHERE FirstName + ' ' + LastName L
我有一个“ super 实体”SuperEntity 和三个扩展父类(super class)的实体 ChildEntity1、...、ChildEntity3。 搜索数据库中的所有实体很容易,即我们
我是一名优秀的程序员,十分优秀!