我正在将我的项目升级到 PHP 8.0+。到目前为止,在代码注释中,我使用了@param和@return标签,如“选项 1”,而不是“选项 2”:
选项1:
@param string[] ...。@return User[] ...。选项2:
@param array ...。@return array ...。不过,因为我不知道第一种形式是否被官方允许,所以我开始问自己,切换到第二种形式是否会更好......所以,我想问你:有吗?有没有可用的 PHP 代码文档官方PHPDoc 参考资料?
另外,是否建议使用第一个选项而不是第二个选项?换句话说:是否有任何反对的论据——也考虑到未来?
感谢您的时间。
PS :我找到了PHPDocumentor的参考资料,但我有一种感觉,它不是官方的 PHP 参考资料,而且还不兼容 PHP 8.0+。
我有以下观点:
class PersonalInfos(generics.RetrieveUpdateAPIView):
serializer_class = ClientSerializer
permission_classes = [IsAuthenticated]
def get_queryset(self):
"""
:return: A QuerySet Object
"""
return Client.objects.get(user=self.request.user)
def get(self, *args):
"""
:param args: Handled by rest_framework views.dispatch
:return: JSON object containing User Personal Data
"""
queryset = self.get_queryset()
serializer = ClientSerializer(queryset)
return Response(data=serializer.data)
def patch(self, request):
"""
:param request: request object is sent by the client
:return: Json response with the data sent of the body
"""
client = self.get_queryset()
serializer = ClientSerializer(client, data=request.data, partial=True)
if serializer.is_valid():
serializer.save() …Run Code Online (Sandbox Code Playgroud) 我似乎无法找到这个宏的定义@.或其.本身。我知道这是一个元素运算。但如何才能将它发挥到极致,对我来说仍然是个秘密。
例如,JavaScript 有 foreach(i,e){},您可以在其中使用 (i) 索引和 (e) 元素等。
我知道这些error_reporting值的含义。我知道-1意思是“显示全部”,0意思是“不显示”。
但是当用户没有指定任何内容时,没有任何地方指定默认设置的值是什么。
尝试phpinfo()我看到
...
Configuration File (php.ini) Path => /usr/local/etc/php
Loaded Configuration File => (none)
...
Run Code Online (Sandbox Code Playgroud)
那么,鉴于没有php.ini加载,默认值/行为是什么error_reporting?
我正在尝试向我的 Rest API(Gin 框架)添加文档,并且在尝试构建 JSON 主体参数时遇到了一些问题。
目前我有以下API描述操作:
// @Summary logins a user
// @ID login-user
// @Accept json
// @Produce json
// @Param email formData string true "user email"
// @Param password formData string true "user password"
// @Success 200 {object} gin.H "login response"
// @Failure 400 {object} gin.H "error response"
// @Router /login [post]
func (server *Server) handleLoginUser() gin.HandlerFunc {
return func(ctx *gin.Context) {
var req loginUserRequest
if err := ctx.ShouldBindJSON(&req); err != nil {
ctx.JSON(http.StatusBadRequest, utils.ErrorResponse(err))
return
} …Run Code Online (Sandbox Code Playgroud) 根据您的说法,iPhone开发人员文档涵盖的最重要的主题(章节)是什么?
您是否知道另一个对您来说非常重要的主题,但很少被其他开发人员阅读?
我想打印并阅读一些重要章节,但我可能会忘记一些事情......
有人可以指向我描述MT消息字段的格式规则的文档吗?
例如,我想知道以下代码段的含义.
:4℃// 3/3/15D!!
我有一些perl代码(约300-500行),我必须再次工作.我的编程经验有限,通常如果我编码我只是找到对我有意义的最佳解决方案.在这种情况下,我必须使用此代码,因为它是为现有的遗留系统构建的,其代码是系统的布线,逻辑和渲染的文档.这不是很多代码,但我也无法发布甚至大块的代码或数据来获得帮助.什么是理解语法,它正在做什么,如何连接代码,逻辑如何模型等的最佳方法.
问题,反馈,评论 - 只是评论,谢谢!
我只是写了一些代码注释,现在我希望<see>或<seealso>标签链接另一种方法.我怎样才能做到这一点?我刚刚看到这样做了.
是否有语言标准(或通用实践)来描述包含类名的Objective-C方法?
例如,假设我有以下伪代码:
class Foo
{
void bar(int i);
}
Run Code Online (Sandbox Code Playgroud)
我想为它写一些文档.
如果这是Java,我会将该方法称为Foo.bar().如果它是C++,我会用Foo::bar.为Objective-C做这个的正确方法是什么?
我知道我可以使用-(void) bar:(int)i,但这不包括类(或协议)名称.