self-documenting-code相关内容

在 Python 中,如何指示我正在覆盖一个方法?

例如,在 Java 中,@Override 注释不仅提供了对覆盖的编译时检查,而且还生成了出色的自文档化代码. 我只是在寻找文档(尽管如果它是像 pylint 这样的检查器的指示器,那是一种奖励).我可以在某处添加注释或文档字符串,但是在 Python 中指示覆盖的惯用方法是什么? 解决方案 基于这个和 fwc:s answer 我创建了一个 pip installable pack ..
发布时间:2021-12-17 19:25:50 Python

PHP:使用数组键识别函数参数

我用户定义了许多函数,其中一些具有六个,十个甚至更多的参数.当我忘记一个函数的参数是什么或它们的顺序时,阅读代码变得很困难.我设计了一种方法来解决这个问题,用单个数组替换所有参数,并使用数组键作为标签每个论点.因此,例如,代替 function MyFunction(string $sSayThis, int $nRepeatTimes, bool $bLoud = $false) {... ..
发布时间:2020-08-06 01:47:08 PHP

人们在现实世界中使用匈牙利命名约定吗?

值得学习该约定还是对可读性和可维护性的祸害? 解决方案 考虑到大多数使用匈牙利表示法的人都遵循了被误解的版本,所以我认为这毫无意义. > 如果要使用它的原始定义,可能会更有意义,但除此之外,它主要是语法糖. 如果您阅读有关该主题的 Wikipedia文章,则会发现两个相互矛盾的符号, 系统匈牙利表示法和 Apps匈牙利表示法. 最初的好定义是 Apps匈牙利符号,但是大多数人 ..

在Python中,我如何表明我重写了一个方法?

在Java中,例如, @Override 注释不仅提供了覆盖的编译时检查,而且还提供了出色的自我记录代码。 我只是在寻找文件(虽然如果它是像pylint这样的检查器的指示器,那就是奖金)。我可以在某处添加注释或docstring,但在Python中指示覆盖的惯用方法是什么? 解决方案 更新(2015年5月23日):根据这个和fwc:s的答案我创建了一个pip可安装程序包 https: ..
发布时间:2018-08-03 14:42:53 Python