php - 记录 PHP 代码 - 它会影响性能吗?

标签 php documentation

<分区>

我不敢相信通常会有人反对文档和评论,但是在 PHP 中这样做的最佳实践(和实践)是什么?

在 JavaScript 中,您可以记录您的代码,然后运行一个最小化程序来生成您的代码的生产版本以供使用。在 PHP 中,额外的文本行会影响性能吗?您是否应该将文档保存在另一个文件中(我认为这对 API 和框架可能很重要,但会减慢您的开发速度)?

编辑:

我的逻辑是,它必然会花费更长的时间,因为文件的大小更长,并且为解析器增加了更多的工作(尽管可能忽略不计)。假设您有 1000 行代码和 500 行注释,您是否应该放一个摘要版本,然后直接转到实际的文档页面?

最佳答案

使用 PHP(如 ASP.NET)可以在服务器上编译代码并生成 HTML 以通过网络发送到客户端。

PHP source code is compiled on-the-fly to an internal format that can be executed by the PHP engine. In order to speed up execution time and not have to compile the PHP source code every time the webpage is accessed, PHP scripts can also be deployed in executable format using a PHP compiler.

Source

在此过程中,评论将被忽略,并且不会在程序中发挥进一步作用。它们不会降低编译器的速度,因此不会影响性能。

您应该对您的代码进行注释(在适当的情况下)并将注释与源代码一起保存。否则,他们很有可能会与代码脱节,然后变得比无用更糟。

关于php - 记录 PHP 代码 - 它会影响性能吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3113788/

相关文章:

php - 在函数调用中返回许多列

javascript - 拉拉维尔 5.2 : How to post and delete data Using Ajax?

php - 从不同的关系中获取最新的 eloquent laravel

javascript - JSDoc 必需参数和默认值

phpDoc 类常量文档

php - isset条件在不同的点击下表现不同

php - 使用 jQuery 发布的 AJAX 数据包含引号?

objective-c - Xcode 和 XIB 自文档

documentation - 如何说服人们评论他们的代码

javascript - JSDoc : @typedef {Object} . 。如何在 @typedef 处记录对象内部的方法