- 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/
所以`MKAnnotation's。有趣的东西。 我的问题: 注释的标题和副标题有什么区别?这对注释的视觉组件有何影响? MKPinAnnotationView 和 MKAnnotationView
我正在使用 JBoss 工具将 DB 模式反向工程到 POJO 中。具体来说,我在 hibernatetool ANT 任务中使用了 hbm2java 选项。在 hbm2java 选项下,您可以指定
假设我有这段文字: cat file /* comment */ not a comment /* another comment */ /* delete this * /* multiline
我明白,如果你///在类、字段、方法或属性上方 Visual Studio 将开始为您建立 XML 样式的注释。 但是,我在哪里可以为我的命名空间和/或库添加 XML 注释... 例如: .NET F
int API_VERSION = 21; @TargetApi(API_VERSION)在Android中用于指定该方法/类支持API_VERSION及以下。 我们是否可以镜像类似的东西,指定仅支持
Closed. This question needs to be more focused。它当前不接受答案。
假设我有一个界面如下。 public interface MyInterface{ /** * This method prints hello */ void sayHello();
我已将 Jboss 应用程序迁移到 WebSphere Liberty。我必须删除所有 Jboss 引用库。在这样做的同时,我在某些注释中面临问题。 Jboss 应用程序使用 @SecurityDom
在本教程中,您将了解 JavaScript 注释,为什么要使用它们以及在示例的帮助下如何使用它们。 JavaScript 注释是程序员可以添加的提示,以使代码更易于阅读和理解。JavaScri
我正在建立一个博客,为了发表评论,我有这个 CSS。 #comments { position:absolute; border: 1px solid #900; border-width: 1
我正在尝试在单元格中插入评论。我正在尝试按照代码进行评论,但它没有在创建的 excel 中显示评论。我正在创建 .xls 扩展名。 $objPHPExcel->getActiveSheet()->ge
我正在使用 TS 在 MarionetteJS 上编写项目,我想使用注释来注册路由。例如: @Controller class SomeController { @RouteMapping("so
我有一个应用程序可以在页面上生成大量注释。用户可以单击页面上的任意位置以创建快速注释(例如 Acrobat Pro)可以在一般 中使用一些 javascript 行添加和删除这些注释
是否有 JavaScript 注释? 当然 JavaScript 没有它们,但是是否有额外的库或建议的语言扩展,例如 @type {folder.otherjsmodule.foo} function
Java 中注解的目的是什么?我有一个模糊的想法,认为它们介于注释和实际代码之间。它们在运行时会影响程序吗? 它们的典型用法是什么? 它们是 Java 独有的吗?有 C++ 等价物吗? 最佳答案 注解
其实我们在 Ruby 基础语法 已经比较详细的介绍了 Ruby 语言中的注释 Ruby 解释器会忽略注释语句 注释会对 Ruby 解释器隐藏一行,或者一行的一部分,或者若干行。 Ruby 中的注
我正在 try catch VBA 注释。到目前为止,我有以下内容 '[^";]+\Z 它捕获以单引号开头但在字符串结尾之前不包含任何双引号的任何内容。即它不会匹配双引号字符串中的单引号。 dim s
有没有办法在'svn commit'上将提交注释添加到更改的文件中。有人告诉我有一种方法可以用 cvs 做到这一点,但我们使用 svn。目前,我们使用“$Revision”关键字将修订号添加到更改的文
我正在尝试通过 ManyToMany 注释自动对报告的结果进行排序 @OrderBy : /** * @ORM\ManyToMany(targetEntity="Artist", inversedB
我正在使用 JBoss 5 GA,我创建了一个测试 session bean 和本地接口(interface)。我创建了一个 servlet 客户端。我尝试使用 @EJB 将接口(interface)
我是一名优秀的程序员,十分优秀!