В целях документации я хочу зафиксировать комментарии каждой функции, которая находится над ее кодом.
Я могу перебирать файл по именам их функций. Как только я получаю строку имени функции, я хочу зафиксировать ее комментарий, который находится над ней. комментарий находится в блоке '/** xxx */'
/**
* this is the comment
* this is the comment
* this is the comment
*/
@Attribute(type = Attribute.STRING.class)
String RESPONSE_TEXT = "responseText";
/**
* this is the comment
* this is the comment
*/
@Attribute(type = Attribute.LONG.class)
String TIME = "clTimestamp";
@ Давео Да! начинается с @attribute






это нужно для работы:
data = open(file_name).read()
data = data.split('/**')
old = data
data = list()
for i in old:
data.extend(old.split('*/'))
comments = []
for i in range(1, len(data), 2):
comments.append(data[i])
for k in comments:
print(k)
data = data.split('*/'), вероятно, вызовет 'list' object has no attribute 'split', потому что вторая строка изменяет содержимое data с байтов файла в строке на список, а списки не имеют метода-члена с именем split().
Та же проблема возникнет в 6-й строке, потому что вы присвоили data возвращаемое значение data.split(), которое является list.
я и это исправил
Я предлагаю вам запустить свой код, прежде чем публиковать его в качестве решения. Ваш код все еще не работает. Проверьте 6-ю строку. Вы пытаетесь запустить split(...) на old, которому вы присвоили data, которому, в свою очередь, было присвоено возвращаемое значение data.split(...). data.split(...) возвращает list.
Теперь, когда я знаю, что строка имени функции начинается с @Attribute, это довольно легко сделать с помощью регулярного выражения (модуль re), что можно сделать следующим образом:
import re
content = '''
/**
* this is the comment
* this is the comment
* this is the comment
*/
@Attribute(type = Attribute.STRING.class)
String RESPONSE_TEXT = "responseText";
/**
* this is the comment
* this is the comment
*/
@Attribute(type = Attribute.LONG.class)
String TIME = "clTimestamp";
'''
comments = re.findall(r'(/\*\*.*?\*/)\n(@Attribute[^\n]*)',content,re.DOTALL)
print('Function comments:')
for i in comments:
print(i[1])
print(i[0])
print('\n')
Выход:
Function comments
@Attribute(type = Attribute.STRING.class)
/**
* this is the comment
* this is the comment
* this is the comment
*/
@Attribute(type = Attribute.LONG.class)
/**
* this is the comment
* this is the comment
*/
Для ясности я жестко закодировал content, я использовал re.findall с шаблоном, который имеет две группы, одна для комментария, вторая для имени, таким образом, он дает list из 2-tuples, каждая из которых состоит из комментария и имени функции. Обратите внимание, что re.DOTALL означает, что .*? может давать многострочное совпадение и экранирование символов со специальным значением, а именно * как \*.
x = find_comment(x, "/*", "*/", 2)
x = find_comment(x, "//", "\n", 0)
def find_comment(n_array, start_string, end_string, add_index):
comment_index = n_array.find(start_string)
if comment_index != -1:
comment_end_index = n_array.find(end_string, comment_index)
print(comment_end_index)
if len(n_array) > comment_end_index:
print(n_array[comment_index:comment_end_index + add_index])
n_array = n_array[0: comment_index:] + n_array[comment_end_index + add_index::]
find_comment(n_array, start_string, end_string, add_index)
return n_array
return n_array
Добавьте описание вашего ответа
Каждый ли строка имени функции начинается с
@?