Python如何写注释?

发布时间 2023-11-06 18:56:16作者: 山雨欲來風滿楼

python如何写给函数写注释:

样板:

    def read_baseline(self, sheet='internal', category='ipe_flip', ):

        """
        功能:
        - 从baseline的Excel文件中读取数据。

        参数:
        - sheet: 要读取的sheet名称,默认为internal
        - category: 要读取的数据类别,默认为ipe_flip

        返回:
        - latency: category对应的latency值
        - throughput: category对应的throughput值

        如果指定的category在baseline中未找到,返回(None, None)。
        """


        df = self.baseline_sheets[sheet]
        result = df.loc[df['category'] == category]  # 从category列中筛选出ipe_flip的值
        # print(result)
        if len(result) == 0:
            return None, None

        return result.iloc[0][1], result.iloc[0][2]

 

有一说一,这个注释是AI写的,比我写的好多了,真规范!!!,记录一下。

参考资料:https://claude.ai/